Add missing import.
[bertos.git] / wizard / BProject.py
index e5baa28f90c3abdd2e6d4e65db3c6e32e71e13f1..32fa159caeb4a0a7e50bbec7b35554620bb758b5 100644 (file)
@@ -37,6 +37,8 @@ import os
 import fnmatch
 import copy
 import pickle
+import shutil
+import copytree
 
 import DefineException
 
@@ -48,12 +50,18 @@ from bertos_utils import (
                             # Utility functions
                             isBertosDir, getTagSet, getInfos, updateConfigurationValues,
                             loadConfigurationInfos, loadDefineLists, loadModuleDefinition,
-                            getCommentList,
+                            getCommentList, sub,
+
+                            # Project creation functions
+                            projectFileGenerator, versionFileGenerator, makefileGenerator,
+                            userMkGenerator, mkGenerator, loadPlugin, mergeSources,
 
                             # Custom exceptions
                             ParseError, SupportedException
                         )
 
+from compatibility import updateProject
+
 class BProject(object):
     """
     Simple class for store and retrieve project informations.
@@ -62,7 +70,9 @@ class BProject(object):
     def __init__(self, project_file="", info_dict={}):
         self.infos = {}
         self._cached_queries = {}
+        self.edit = False
         if project_file:
+            self.edit = True
             self.loadBertosProject(project_file, info_dict)
 
     #--- Load methods (methods that loads data into project) ------------------#
@@ -70,41 +80,49 @@ class BProject(object):
     def loadBertosProject(self, project_file, info_dict):
         project_dir = os.path.dirname(project_file)
         project_data = pickle.loads(open(project_file, "r").read())
+        updateProject(project_data)
         # If PROJECT_NAME is not defined it use the directory name as PROJECT_NAME
         # 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)
+        project_src_path = project_data.get("PROJECT_SRC_PATH", None)
+        project_src_path = os.path.join(project_dir, project_data.get("PROJECT_SRC_PATH", None))
+        if project_src_path:
+            self.infos["PROJECT_SRC_PATH"] = project_src_path
+            
+        else:
+            # In projects created with older versions of the Wizard this metadata doesn't exist
+            self.infos["PROJECT_SRC_PATH"] = os.path.join(self.infos["PROJECT_PATH"], self.infos["PROJECT_NAME"])
 
-        # Check for the Wizard version
-        wizard_version = project_data.get("WIZARD_VERSION", 0)
-        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))
+        linked_sources_path = project_data["BERTOS_PATH"]
+        sources_abspath = os.path.abspath(os.path.join(project_dir, linked_sources_path))
+        project_data["BERTOS_PATH"] = sources_abspath
+        
+        self._loadBertosSourceStuff(project_data["BERTOS_PATH"], info_dict.get("BERTOS_PATH", None))
+        
+        self.infos["PRESET"] = project_data.get("PRESET", False)
 
         # For those projects that don't have a VERSION file create a dummy one.
-        if not isBertosDir(project_dir):
+        if not isBertosDir(project_dir) and not self.is_preset:
             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._loadCpuStuff(project_data["CPU_NAME"], project_data["SELECTED_FREQ"])
+        self._loadToolchainStuff(project_data["TOOLCHAIN"], info_dict.get("TOOLCHAIN", None))
         self.infos["OUTPUT"] = project_data["OUTPUT"]
         self.loadModuleData(True)
         self.setEnabledModules(project_data["ENABLED_MODULES"])
 
-    def _loadBertosSourceStuff(self, project_data, forced_version=None):
-        bertos_source_path = project_data["SOURCES_PATH"]
+    def _loadBertosSourceStuff(self, sources_path, forced_version=None):
         if forced_version:
-            bertos_source_path = forced_version
-        if os.path.exists(bertos_source_path):
-            self.infos["SOURCES_PATH"] = bertos_source_path
+            sources_path = forced_version
+        if os.path.exists(sources_path):
+            self.infos["BERTOS_PATH"] = sources_path
         else:
             raise VersionException(self)
 
-    def _loadCpuStuff(self, project_data):
-        cpu_name = project_data["CPU_NAME"]
+    def _loadCpuStuff(self, cpu_name, cpu_frequency):
         self.infos["CPU_NAME"] = cpu_name
         cpu_info = self.getCpuInfos()
         for cpu in cpu_info:
@@ -123,10 +141,10 @@ class BProject(object):
             else:
                 tag_dict[tag] = False
         self.infos["ALL_CPU_TAGS"] = tag_dict
-        self.infos["SELECTED_FREQ"] = project_data["SELECTED_FREQ"]
+        self.infos["SELECTED_FREQ"] = cpu_frequency
 
-    def _loadToolchainStuff(self, project_data, forced_toolchain=None):
-        toolchain = project_data["TOOLCHAIN"]
+    def _loadToolchainStuff(self, toolchain, forced_toolchain=None):
+        toolchain = toolchain
         if forced_toolchain:
             toolchain = forced_toolchain
         if os.path.exists(toolchain["path"]):
@@ -139,14 +157,43 @@ class BProject(object):
         Load a project from a preset.
         NOTE: this is a stub.
         """
-        self.loadBertosProject(os.path.join(preset, 'project.bertos'), {})
+        project_file = os.path.join(preset, "project.bertos")
+        project_data = pickle.loads(open(project_file, "r").read())
+        self.loadSourceTree()
+        self._loadCpuStuff(project_data["CPU_NAME"], project_data["SELECTED_FREQ"])
+        self._loadToolchainStuff(project_data["TOOLCHAIN"])
+
+        # NOTE: this is a HACK!!!
+        # TODO: find a better way to reuse loadModuleData
+        preset_project_name = project_data.get("PROJECT_NAME", os.path.basename(preset))
+        preset_prj_src_path = os.path.join(preset, project_data.get("PROJECT_SRC_PATH", os.path.join(preset, preset_project_name)))
+
+        old_project_name = self.infos["PROJECT_NAME"]
+        old_project_path = self.infos["PROJECT_PATH"]
+        old_project_src_path = self.infos["PROJECT_SRC_PATH"]
+
+        self.infos["PROJECT_NAME"] = preset_project_name
+        self.infos["PROJECT_PATH"] = preset
+        self.infos["PROJECT_SRC_PATH"] = preset_prj_src_path
+
+        self.loadModuleData(True)
+        self.setEnabledModules(project_data["ENABLED_MODULES"])
+
+        self.infos["PROJECT_NAME"] = old_project_name
+        self.infos["PROJECT_PATH"] = old_project_path
+        self.infos["PROJECT_SRC_PATH"] = old_project_src_path
+        # End of the ugly HACK!
+
+        self.infos["PRESET_NAME"] = preset_project_name
+        self.infos["PRESET_PATH"] = preset
+        self.infos["PRESET_SRC_PATH"] = preset_prj_src_path
 
     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_path = os.path.join(self.infos["BERTOS_PATH"], const.PREDEFINED_BOARDS_DIR)
         preset_tree = {}
         if os.path.exists(preset_path):
             preset_tree = self._loadProjectPresetTree(preset_path)
@@ -154,22 +201,22 @@ class BProject(object):
 
     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'] = []
+        _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))
+                    _tree["children"].append(self._loadProjectPresetTree(_path))
         # Add into the info dict the dir type (dir/project)
-        if _tree['children']:
-            _tree['info']['type'] = 'dir'
+        if _tree["children"]:
+            _tree["info"]["type"] = "dir"
         else:
-            _tree['info']['type'] = 'project'
+            _tree["info"]["type"] = "project"
         return _tree
 
     def _loadPresetInfo(self, preset_spec_file):
@@ -199,17 +246,16 @@ class BProject(object):
                     if "configuration" in information and len(information["configuration"]):
                         configuration = module_dict[module]["configuration"]
                         try:
-                            configuration_info[configuration] = loadConfigurationInfos(self.infos["SOURCES_PATH"] + "/" + configuration)
+                            configuration_info[configuration] = loadConfigurationInfos(self.infos["BERTOS_PATH"] + "/" + configuration)
                         except ParseError, err:
-                            raise DefineException.ConfigurationDefineException(self.infos["SOURCES_PATH"] + "/" + configuration, err.line_number, err.line)
+                            raise DefineException.ConfigurationDefineException(self.infos["BERTOS_PATH"] + "/" + configuration, err.line_number, err.line)
                         if edit:
                             try:
-                                path = self.infos["PROJECT_NAME"]
-                                directory = self.infos["PROJECT_PATH"]
-                                user_configuration = loadConfigurationInfos(directory + "/" + configuration.replace("bertos", path))
+                                path = self.infos["PROJECT_SRC_PATH"]
+                                user_configuration = loadConfigurationInfos(configuration.replace("bertos", path))
                                 configuration_info[configuration] = updateConfigurationValues(configuration_info[configuration], user_configuration)
                             except ParseError, err:
-                                raise DefineException.ConfigurationDefineException(directory + "/" + configuration.replace("bertos", path))
+                                raise DefineException.ConfigurationDefineException(configuration.replace("bertos", path))
                 module_info_dict.update(module_dict)
                 configuration_info_dict.update(configuration_info)
                 if to_be_parsed:
@@ -231,8 +277,8 @@ class BProject(object):
         """
         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')
+        # Index only the BERTOS_PATH/bertos content
+        bertos_sources_dir = os.path.join(self.info("BERTOS_PATH"), "bertos")
         file_dict = {}
         if os.path.exists(bertos_sources_dir):
             for element in os.walk(bertos_sources_dir):
@@ -247,6 +293,229 @@ class BProject(object):
 
     #-------------------------------------------------------------------------#
 
+    def createBertosProject(self):
+        # NOTE: Temporary hack.
+        if self.edit:
+            self._editBertosProject()
+        else:
+            if not self.from_preset:
+                self._newCustomBertosProject()
+            else:
+                self._newBertosProjectFromPreset()
+
+    def _newBertosProject(self):
+        for directory in (self.maindir, self.srcdir, self.prjdir, self.cfgdir):
+            self._createDirectory(directory)
+        # Write the project file
+        self._writeProjectFile(os.path.join(self.maindir, "project.bertos"))
+        # VERSION file
+        self._writeVersionFile(os.path.join(self.maindir, "VERSION"))
+        # Destination makefile
+        self._writeMakefile(os.path.join(self.maindir, "Makefile"))
+        # Copy the sources
+        self._copySources(self.sources_dir, self.srcdir)
+        # Set properly the autoenabled parameters
+        self._setupAutoenabledParameters()
+        # Copy all the configuration files
+        self._writeCfgFiles(self.sources_dir, self.cfgdir)
+        # Destination wizard mk file
+        self._writeWizardMkFile(os.path.join(self.prjdir, os.path.basename(self.prjdir) + "_wiz.mk"))
+
+    def _newCustomBertosProject(self):
+        # Create/write/copy the common things
+        self._newBertosProject()
+        # Copy the clean hw files
+        self._createDirectory(self.hwdir)
+        # Copy all the hw files
+        self._writeHwFiles(self.sources_dir, self.hwdir)
+        # Destination user mk file
+        self._writeUserMkFile(os.path.join(self.prjdir, os.path.basename(self.prjdir) + ".mk"))
+        # Destination main.c file
+        self._writeMainFile(self.prjdir + "/main.c")
+        # Create project files for selected plugins
+        self._createProjectFiles()
+
+    def _newBertosProjectFromPreset(self):
+        # Create/write/copy the common things
+        self._newBertosProject()
+
+        # Copy all the files and dirs except cfg/hw/*_wiz.mk
+        self._writeCustomSrcFiles()
+
+        if self.infos["EMPTY_MAIN"]:
+            # Create and empty main.c file only if the user check the box
+            self._writeMainFile(self.prjdir + "/main.c")
+
+        # Create project files for selected plugins
+        self._createProjectFiles()
+
+    def _editBertosProject(self):
+        # Write the project file
+        self._writeProjectFile(os.path.join(self.maindir, "project.bertos"))
+        if not self.is_preset:
+            # Generate this files only if the project isn't a preset
+            # VERSION file
+            self._writeVersionFile(os.path.join(self.maindir, "VERSION"))
+            # Destination makefile
+            self._writeMakefile(os.path.join(self.maindir, "Makefile"))
+            # Merge sources
+            self._mergeSources(self.sources_dir, self.srcdir, self.old_srcdir)
+            # Copy all the hw files
+            self._writeHwFiles(self.sources_dir, self.hwdir)
+            # Destination wizard mk file
+            self._writeWizardMkFile(os.path.join(self.prjdir, os.path.basename(self.prjdir) + "_wiz.mk"))
+        # Set properly the autoenabled parameters
+        self._setupAutoenabledParameters()
+        # Copy all the configuration files
+        self._writeCfgFiles(self.sources_dir, self.cfgdir)
+        if not self.is_preset:
+            # Create project files for selected plugins only if the project isn't a preset
+            self._createProjectFiles()
+
+    def _createProjectFiles(self):
+        # Files for selected plugins
+        relevants_files = {}
+        for plugin in self.infos["OUTPUT"]:
+            module = loadPlugin(plugin)
+            relevants_files[plugin] = module.createProject(self)
+        self.infos["RELEVANT_FILES"] = relevants_files
+
+    def _writeVersionFile(self, filename):
+        version_file = open(os.path.join(const.DATA_DIR, "vtemplates/VERSION"), "r").read()
+        open(filename, "w").write(versionFileGenerator(self, version_file))
+
+    def _writeProjectFile(self, filename):
+        f = open(filename, "w")
+        f.write(projectFileGenerator(self))
+        f.close()
+
+    def _writeMakefile(self, filename):
+        makefileGenerator(self, filename)
+
+    def _writeUserMkFile(self, filename):
+        userMkGenerator(self, filename)
+
+    def _writeWizardMkFile(self, filename):
+        mkGenerator(self, filename)
+
+    def _writeMainFile(self, filename):
+        main = open(os.path.join(const.DATA_DIR, "srctemplates/main.c"), "r").read()
+        open(filename, "w").write(main)
+
+    def _writeHwFiles(self, source_dir, destination_dir):
+        for module, information in self.infos["MODULES"].items():
+            for hwfile in information["hw"]:
+                string = open(source_dir + "/" + hwfile, "r").read()
+                hwfile_path = destination_dir + "/" + os.path.basename(hwfile)
+                if not self.edit or not os.path.exists(hwfile_path):
+                    # If not in editing mode it copies all the hw files. If in
+                    # editing mode it copies only the files that don't exist yet
+                    open(os.path.join(destination_dir,os.path.basename(hwfile)), "w").write(string)
+
+    def _writeCfgFiles(self, source_dir, destination_dir):
+        for configuration, information in self.infos["CONFIGURATIONS"].items():
+            string = open(source_dir + "/" + configuration, "r").read()
+            for start, parameter in information["paramlist"]:
+                infos = information[parameter]
+                value = infos["value"]
+                if "unsigned" in infos["informations"] and infos["informations"]["unsigned"]:
+                    value += "U"
+                if "long" in infos["informations"] and infos["informations"]["long"]:
+                    value += "L"
+                string = sub(string, parameter, value)
+            f = open(os.path.join(destination_dir, os.path.basename(configuration)), "w")
+            f.write(string)
+            f.close()
+
+    def _writeCustomSrcFiles(self):
+        origin = self.infos["PRESET_SRC_PATH"]
+        # Files to be ignored (all project files, cfg dir, wizard mk file, all global ignored dirs)
+        project_related_stuff = (
+            "cfg",
+            self.infos["PRESET_NAME"] + "_wiz.mk",
+            "project.bertos",
+            self.infos["PRESET_NAME"] + ".project",
+            self.infos["PRESET_NAME"] + ".workspace",
+        ) + const.IGNORE_LIST
+        for element in os.listdir(origin):
+            if element not in project_related_stuff:
+                full_path = os.path.join(origin, element)
+                if os.path.isdir(full_path):
+                    copytree.copytree(full_path, os.path.join(self.prjdir, element), ignore_list=const.IGNORE_LIST)
+                else:
+                    shutil.copy(full_path, self.prjdir)
+
+    def _setupAutoenabledParameters(self):
+        for module, information in self.infos["MODULES"].items():
+            if "configuration" in information and information["configuration"] != "":
+                configurations = self.infos["CONFIGURATIONS"]
+                configuration = configurations[information["configuration"]]
+                for start, parameter in configuration["paramlist"]:
+                    if "type" in configuration[parameter]["informations"] and configuration[parameter]["informations"]["type"] == "autoenabled":
+                        configuration[parameter]["value"] = "1" if information["enabled"] else "0"
+                self.infos["CONFIGURATIONS"] = configurations
+
+    @property
+    def maindir(self):
+        return self.infos.get("PROJECT_PATH", None)
+
+    @property
+    def srcdir(self):
+        if self.maindir:
+            return os.path.join(self.maindir, "bertos")
+        else:
+            return None
+
+    @property
+    def prjdir(self):
+        return self.infos.get("PROJECT_SRC_PATH", None)
+
+    @property
+    def hwdir(self):
+        if self.prjdir:
+            return os.path.join(self.prjdir, "hw")
+        else:
+            return None
+
+    @property
+    def cfgdir(self):
+        if self.prjdir:
+            return os.path.join(self.prjdir, "cfg")
+        else:
+            return None
+
+    @property
+    def old_srcdir(self):
+        return self.infos.get("OLD_BERTOS_PATH", None)
+
+    @property
+    def sources_dir(self):
+        return self.infos.get("BERTOS_PATH", None)
+
+    @property
+    def from_preset(self):
+        return self.infos.get("PROJECT_FROM_PRESET", False)
+
+    @property
+    def is_preset(self):
+        return self.infos.get("PRESET", False)
+
+    def _createDirectory(self, directory):
+        if not directory:
+            return
+        if os.path.isdir(directory):
+            shutil.rmtree(directory, True)
+        os.makedirs(directory)
+
+    def _copySources(self, origin, destination):
+        # If not in editing mode it copies all the bertos sources in the /bertos subdirectory of the project
+        shutil.rmtree(destination, True)
+        copytree.copytree(origin + "/bertos", destination, ignore_list=const.IGNORE_LIST)
+
+    def _mergeSources(self, origin, destination, old_sources_dir):
+        if old_sources_dir:
+            mergeSources(destination, origin, old_sources_dir)
+
     def setInfo(self, key, value):
         """
         Store the given value with the name key.
@@ -272,8 +541,8 @@ class BProject(object):
         return [(filename, dirname) for dirname in file_dict.get(filename, [])]
 
     def findDefinitions(self, ftype):
-        # Maintain a cache for every scanned SOURCES_PATH
-        definitions_dict = self._cached_queries.get(self.infos["SOURCES_PATH"], {})
+        # Maintain a cache for every scanned BERTOS_PATH
+        definitions_dict = self._cached_queries.get(self.infos["BERTOS_PATH"], {})
         definitions = definitions_dict.get(ftype, None)
         if definitions is not None:
             return definitions
@@ -283,11 +552,11 @@ class BProject(object):
             if fnmatch.fnmatch(filename, ftype):
                 definitions += [(filename, dirname) for dirname in file_dict.get(filename, [])]
 
-        # If no cache for the current SOURCES_PATH create an empty one
+        # If no cache for the current BERTOS_PATH create an empty one
         if not definitions_dict:
-            self._cached_queries[self.infos["SOURCES_PATH"]] = {}
+            self._cached_queries[self.infos["BERTOS_PATH"]] = {}
         # Fill the empty cache with the result
-        self._cached_queries[self.infos["SOURCES_PATH"]][ftype] = definitions
+        self._cached_queries[self.infos["BERTOS_PATH"]][ftype] = definitions
         return definitions
 
     def setEnabledModules(self, enabled_modules):
@@ -303,4 +572,4 @@ class BProject(object):
         self.infos["FILES"] = files
 
     def __repr__(self):
-        return repr(self.infos)
+        return "<BProject:instance %d>%s" %(id(self), repr(self.infos))