Split loadBertosProject method to reuse most of the code for presets.
[bertos.git] / wizard / BProject.py
index 1cbaf1643b69ab878336e1a975f1e83922f19b18..d01e9189b3f9431671cdd57942fff5ab1a3e1855 100644 (file)
@@ -39,6 +39,9 @@ import copy
 import pickle
 
 import DefineException
+
+from LoadException import VersionException, ToolchainException
+
 import const
 
 from bertos_utils import (
@@ -46,7 +49,7 @@ from bertos_utils import (
                             isBertosDir, getTagSet, setEnabledModules, getInfos,
                             loadConfigurationInfos, loadDefineLists, loadModuleDefinition,
                             getCommentList, updateConfigurationValues,
-                            
+
                             # Custom exceptions
                             ParseError, SupportedException
                         )
@@ -55,13 +58,15 @@ class BProject(object):
     """
     Simple class for store and retrieve project informations.
     """
-    
+
     def __init__(self, project_file="", info_dict={}):
         self.infos = {}
         self._cached_queries = {}
         if project_file:
             self.loadBertosProject(project_file, info_dict)
 
+    #--- Load methods (methods that loads data into project) ------------------#
+
     def loadBertosProject(self, project_file, info_dict):
         project_dir = os.path.dirname(project_file)
         project_data = pickle.loads(open(project_file, "r").read())
@@ -69,23 +74,39 @@ class BProject(object):
         # NOTE: this can throw an Exception if the user has changed the directory containing the project
         self.infos["PROJECT_NAME"] = project_data.get("PROJECT_NAME", os.path.basename(project_dir))
         self.infos["PROJECT_PATH"] = os.path.dirname(project_file)
+        
         # Check for the Wizard version
         wizard_version = project_data.get("WIZARD_VERSION", 0)
-        # Ignore the SOURCES_PATH inside the project file
-        project_data["SOURCES_PATH"] = project_dir
-        if "SOURCES_PATH" in info_dict:
-            project_data["SOURCES_PATH"] = info_dict["SOURCES_PATH"]
-        if os.path.exists(project_data["SOURCES_PATH"]):
-            self.infos["SOURCES_PATH"] = project_data["SOURCES_PATH"]
-        else:
-            raise VersionException(self)
+        if wizard_version < 1:
+            # Ignore the SOURCES_PATH inside the project file for older projects
+            project_data["SOURCES_PATH"] = project_dir
+        self.loadBertosSourceStuff(project_data, info_dict.get("SOURCES_PATH", None))
+        
+        # For those projects that don't have a VERSION file create a dummy one.
         if not isBertosDir(project_dir):
             version_file = open(os.path.join(const.DATA_DIR, "vtemplates/VERSION"), "r").read()
             open(os.path.join(project_dir, "VERSION"), "w").write(version_file.replace("$version", "").strip())
+            
         self.loadSourceTree()
+        self.loadCpuStuff(project_data)
+        self.loadToolchainStuff(project_data, info_dict.get("TOOLCHAIN", None))
+        self.infos["OUTPUT"] = project_data["OUTPUT"]
+        self.loadModuleData(True)
+        setEnabledModules(self, project_data["ENABLED_MODULES"])
+
+    def loadBertosSourceStuff(self, project_data, forced_version=None):
+        bertos_source_path = project_data["SOURCES_PATH"]
+        if forced_version:
+            bertos_source_path = forced_version
+        if os.path.exists(bertos_source_path):
+            self.infos["SOURCES_PATH"] = bertos_source_path
+        else:
+            raise VersionException(self)
+
+    def loadCpuStuff(self, project_data):
         cpu_name = project_data["CPU_NAME"]
         self.infos["CPU_NAME"] = cpu_name
-        cpu_info = self.loadCpuInfos()
+        cpu_info = self.getCpuInfos()
         for cpu in cpu_info:
             if cpu["CPU_NAME"] == cpu_name:
                 self.infos["CPU_INFOS"] = cpu
@@ -102,16 +123,59 @@ class BProject(object):
             else:
                 tag_dict[tag] = False
         self.infos["ALL_CPU_TAGS"] = tag_dict
-        if "TOOLCHAIN" in info_dict:
-            project_data["TOOLCHAIN"] = info_dict["TOOLCHAIN"]
-        if os.path.exists(project_data["TOOLCHAIN"]["path"]):
-            self.infos["TOOLCHAIN"] = project_data["TOOLCHAIN"]
+        self.infos["SELECTED_FREQ"] = project_data["SELECTED_FREQ"]
+
+    def loadToolchainStuff(self, project_data, forced_toolchain=None):
+        toolchain = project_data["TOOLCHAIN"]
+        if forced_toolchain:
+            toolchain = forced_toolchain
+        if os.path.exists(toolchain["path"]):
+            self.infos["TOOLCHAIN"] = toolchain
         else:
             raise ToolchainException(self)
-        self.infos["SELECTED_FREQ"] = project_data["SELECTED_FREQ"]
-        self.infos["OUTPUT"] = project_data["OUTPUT"]
-        self.loadModuleData(True)
-        setEnabledModules(self, project_data["ENABLED_MODULES"])
+
+    def loadProjectFromPreset(self, preset):
+        """
+        Load a project from a preset.
+        NOTE: this is a stub.
+        """
+        self.loadBertosProject(os.path.join(preset, 'project.bertos'), {})
+
+    def loadProjectPresets(self):
+        """
+        Load the default presets (into the const.PREDEFINED_BOARDS_DIR).
+        """
+        # NOTE: this method does nothing (for now).
+        preset_path = os.path.join(self.infos["SOURCES_PATH"], const.PREDEFINED_BOARDS_DIR)
+        preset_tree = {}
+        if os.path.exists(preset_path):
+            preset_tree = self._loadProjectPresetTree(preset_path)
+        self.infos["PRESET_TREE"] = preset_tree
+
+    def _loadProjectPresetTree(self, path):
+        _tree = {}
+        _tree['info'] = self._loadPresetInfo(os.path.join(path, const.PREDEFINED_BOARD_SPEC_FILE))
+        _tree['info']['filename'] = os.path.basename(path)
+        _tree['info']['path'] = path
+        _tree['children'] = []
+        entries = set(os.listdir(path))
+        for entry in entries:
+            _path = os.path.join(path, entry)
+            if os.path.isdir(_path):
+                sub_entries = set(os.listdir(_path))
+                if const.PREDEFINED_BOARD_SPEC_FILE in sub_entries:
+                    _tree['children'].append(self._loadProjectPresetTree(_path))
+        # Add into the info dict the dir type (dir/project)
+        if _tree['children']:
+            _tree['info']['type'] = 'dir'
+        else:
+            _tree['info']['type'] = 'project'
+        return _tree
+
+    def _loadPresetInfo(self, preset_spec_file):
+        D = {}
+        execfile(preset_spec_file, {}, D)
+        return D
 
     def loadModuleData(self, edit=False):
         module_info_dict = {}
@@ -154,9 +218,6 @@ class BProject(object):
                         list_info_dict.update(list_dict)
                     except ParseError, err:
                         raise DefineException.EnumDefineException(path, err.line_number, err.line)
-        for filename, path in self.findDefinitions("*_" + self.infos["CPU_INFOS"]["TOOLCHAIN"] + ".h"):
-            comment_list = getCommentList(open(path + "/" + filename, "r").read())
-            list_info_dict.update(loadDefineLists(comment_list))
         for tag in self.infos["CPU_INFOS"]["CPU_TAGS"]:
             for filename, path in self.findDefinitions("*_" + tag + ".h"):
                 comment_list = getCommentList(open(path + "/" + filename, "r").read())
@@ -166,23 +227,32 @@ class BProject(object):
         self.infos["CONFIGURATIONS"] = configuration_info_dict
         self.infos["FILES"] = file_dict
 
-    def loadCpuInfos(self):
-        cpuInfos = []
-        for definition in self.findDefinitions(const.CPU_DEFINITION):
-            cpuInfos.append(getInfos(definition))
-        return cpuInfos
+    def loadSourceTree(self):
+        """
+        Index BeRTOS source and load it in memory.
+        """
+        # Index only the SOURCES_PATH/bertos content
+        bertos_sources_dir = os.path.join(self.info("SOURCES_PATH"), 'bertos')
+        file_dict = {}
+        if os.path.exists(bertos_sources_dir):
+            for element in os.walk(bertos_sources_dir):
+                for f in element[2]:
+                    file_dict[f] = file_dict.get(f, []) + [element[0]]
+        self.infos["FILE_DICT"] = file_dict
 
     def reloadCpuInfo(self):
-        for cpu_info in self.loadCpuInfos():
-            if cpu_info["CPU_NAME"]:
+        for cpu_info in self.getCpuInfos():
+            if cpu_info["CPU_NAME"] == self.infos["CPU_NAME"]:
                 self.infos["CPU_INFOS"] = cpu_info
 
+    #-------------------------------------------------------------------------#
+
     def setInfo(self, key, value):
         """
         Store the given value with the name key.
         """
         self.infos[key] = value
-    
+
     def info(self, key, default=None):
         """
         Retrieve the value associated with the name key.
@@ -191,22 +261,20 @@ class BProject(object):
             return copy.deepcopy(self.infos[key])
         return default
 
-    def loadSourceTree(self):
-        # Index only the SOURCES_PATH/bertos content
-        bertos_sources_dir = os.path.join(self.info("SOURCES_PATH"), 'bertos')
-        file_dict = {}
-        if os.path.exists(bertos_sources_dir):
-            for element in os.walk(bertos_sources_dir):
-                for f in element[2]:
-                    file_dict[f] = file_dict.get(f, []) + [element[0]]
-        self.infos["FILE_DICT"] = file_dict
+    def getCpuInfos(self):
+        cpuInfos = []
+        for definition in self.findDefinitions(const.CPU_DEFINITION):
+            cpuInfos.append(getInfos(definition))
+        return cpuInfos
 
     def searchFiles(self, filename):
         file_dict = self.infos["FILE_DICT"]
         return [(filename, dirname) for dirname in file_dict.get(filename, [])]
 
     def findDefinitions(self, ftype):
-        definitions = self._cached_queries.get(ftype, None)
+        # Maintain a cache for every scanned SOURCES_PATH
+        definitions_dict = self._cached_queries.get(self.infos["SOURCES_PATH"], {})
+        definitions = definitions_dict.get(ftype, None)
         if definitions is not None:
             return definitions
         file_dict = self.infos["FILE_DICT"]
@@ -214,8 +282,13 @@ class BProject(object):
         for filename in file_dict:
             if fnmatch.fnmatch(filename, ftype):
                 definitions += [(filename, dirname) for dirname in file_dict.get(filename, [])]
-        self._cached_queries[ftype] = definitions
+
+        # If no cache for the current SOURCES_PATH create an empty one
+        if not definitions_dict:
+            self._cached_queries[self.infos["SOURCES_PATH"]] = {}
+        # Fill the empty cache with the result
+        self._cached_queries[self.infos["SOURCES_PATH"]][ftype] = definitions
         return definitions
 
     def __repr__(self):
-        return repr(self.infos)
\ No newline at end of file
+        return repr(self.infos)