Use " instead of ' for BProject file (to follow the BeRTOS wizard coding standard).
[bertos.git] / wizard / BProject.py
index f5bc900da7ab36ee583d6dcfe9010e9a2c599212..edba9d661c029ecef64ae74ab33da37c4e37d745 100644 (file)
@@ -51,10 +51,10 @@ from bertos_utils import (
                             isBertosDir, getTagSet, getInfos, updateConfigurationValues,
                             loadConfigurationInfos, loadDefineLists, loadModuleDefinition,
                             getCommentList, sub,
-                            
+
                             # Project creation functions
                             projectFileGenerator, versionFileGenerator, makefileGenerator,
-                            userMkGenerator, mkGenerator, loadPlugin,
+                            userMkGenerator, mkGenerator, loadPlugin, mergeSources,
 
                             # Custom exceptions
                             ParseError, SupportedException
@@ -68,7 +68,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) ------------------#
@@ -157,7 +159,9 @@ class BProject(object):
         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_PATH"] = old_project_path
+        self.infos["PRESET_NAME"] = project_data.get("PROJECT_NAME", os.path.basename(preset))
+        self.infos["PRESET_PATH"] = preset
 
     def loadProjectPresets(self):
         """
@@ -172,22 +176,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):
@@ -250,7 +254,7 @@ 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')
+        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):
@@ -265,74 +269,130 @@ class BProject(object):
 
     #-------------------------------------------------------------------------#
 
-    def createBertosProject(self, edit=False):
-        directory = self.infos["PROJECT_PATH"]
-        sources_dir = self.infos["SOURCES_PATH"]
-        old_sources_dir = self.infos.get("OLD_SOURCES_PATH", None)
-        if not edit:
-            if os.path.isdir(directory):
-                shutil.rmtree(directory, True)        
-            os.makedirs(directory)
+    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.hwdir, self.cfgdir):
+            self._createDirectory(directory)
         # Write the project file
-        f = open(directory + "/project.bertos", "w")
-        f.write(projectFileGenerator(self))
-        f.close()
+        self._writeProjectFile(os.path.join(self.maindir, "project.bertos"))
         # VERSION file
-        version_file = open(os.path.join(const.DATA_DIR, "vtemplates/VERSION"), "r").read()
-        open(directory + "/VERSION", "w").write(versionFileGenerator(self, version_file))
-        # Destination source dir
-        srcdir = directory + "/bertos"
-        if not edit:
-            # If not in editing mode it copies all the bertos sources in the /bertos subdirectory of the project
-            shutil.rmtree(srcdir, True)
-            copytree.copytree(sources_dir + "/bertos", srcdir, ignore_list=const.IGNORE_LIST)
-        elif old_sources_dir:
-            # If in editing mode it merges the current bertos sources with the selected ones
-            # TODO: implement the three way merge algotihm
-            #
-            mergeSources(srcdir, sources_dir, old_sources_dir)
+        self._writeVersionFile(os.path.join(self.maindir, "VERSION"))
         # Destination makefile
-        makefile = directory + "/Makefile"
-        makefile = open(os.path.join(const.DATA_DIR, "mktemplates/Makefile"), 'r').read()
-        makefile = makefileGenerator(self, makefile)
-        open(directory + "/Makefile", "w").write(makefile)
-        # Destination project dir
-        # prjdir = directory + "/" + os.path.basename(directory)
-        prjdir = os.path.join(directory, self.infos["PROJECT_NAME"])
-        if not edit:
-            shutil.rmtree(prjdir, True)
-            os.mkdir(prjdir)
-        # Destination hw files
-        hwdir = prjdir + "/hw"
-        if not edit:
-            shutil.rmtree(hwdir, True)
-            os.mkdir(hwdir)
+        self._writeMakefile(os.path.join(self.maindir, "Makefile"))
+        # Copy the sources
+        self._copySources(self.sources_dir, self.srcdir)
         # Copy all the hw files
+        self._writeHwFiles(self.sources_dir, self.hwdir)
+        # 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()
+        # 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"))
+        # 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)
+        # 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"))
+        # Create project files for selected plugins
+        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):
+        makefile = open(os.path.join(const.DATA_DIR, "mktemplates/Makefile"), "r").read()
+        makefile = makefileGenerator(self, makefile)
+        open(filename, "w").write(makefile)
+
+    def _writeUserMkFile(self, filename):
+        makefile = open(os.path.join(const.DATA_DIR, "mktemplates/template.mk"), "r").read()
+        # Deadly performances loss was here :(
+        makefile = userMkGenerator(self, makefile)
+        open(filename, "w").write(makefile)
+
+    def _writeWizardMkFile(self, filename):
+        makefile = open(os.path.join(const.DATA_DIR, "mktemplates/template_wiz.mk"), "r").read()
+        makefile = mkGenerator(self, makefile)
+        open(filename, "w").write(makefile)
+
+    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(sources_dir + "/" + hwfile, "r").read()
-                hwfile_path = hwdir + "/" + os.path.basename(hwfile)
-                if not edit or not os.path.exists(hwfile_path):
+                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(hwdir + "/" + os.path.basename(hwfile), "w").write(string)
-        # Destination configurations files
-        cfgdir = prjdir + "/cfg"
-        if not edit:
-            shutil.rmtree(cfgdir, True)
-            os.mkdir(cfgdir)
-        # Set properly the autoenabled parameters
-        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
-        # Copy all the configuration files
+                    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(sources_dir + "/" + configuration, "r").read()
+            string = open(source_dir + "/" + configuration, "r").read()
             for start, parameter in information["paramlist"]:
                 infos = information[parameter]
                 value = infos["value"]
@@ -341,29 +401,92 @@ class BProject(object):
                 if "long" in infos["informations"] and infos["informations"]["long"]:
                     value += "L"
                 string = sub(string, parameter, value)
-            f = open(cfgdir + "/" + os.path.basename(configuration), "w")
+            f = open(os.path.join(destination_dir, os.path.basename(configuration)), "w")
             f.write(string)
             f.close()
-        if not edit:
-            # Destination user mk file (only on project creation)
-            makefile = open(os.path.join(const.DATA_DIR, "mktemplates/template.mk"), "r").read()
-            # Deadly performances loss was here :(
-            makefile = userMkGenerator(self, makefile)
-            open(prjdir + "/" + os.path.basename(prjdir) + ".mk", "w").write(makefile)
-        # Destination wizard mk file
-        makefile = open(os.path.join(const.DATA_DIR, "mktemplates/template_wiz.mk"), "r").read()
-        makefile = mkGenerator(self, makefile)
-        open(prjdir + "/" + os.path.basename(prjdir) + "_wiz.mk", "w").write(makefile)
-        # Destination main.c file
-        if not edit:
-            main = open(os.path.join(const.DATA_DIR, "srctemplates/main.c"), "r").read()
-            open(prjdir + "/main.c", "w").write(main)
-        # 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 _writeCustomSrcFiles(self):
+        preset = self.infos["PRESET_PATH"]
+        preset_name = self.infos["PRESET_NAME"]
+        origin = os.path.join(preset, preset_name)
+        project_related_stuff = ("cfg", "hw", self.infos["PROJECT_NAME"] + "_wiz.mk") + 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):
+        if self.maindir:
+            return os.path.join(self.maindir, self.infos["PROJECT_NAME"])
+        else:
+            return 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_SOURCES_PATH", None)
+
+    @property
+    def sources_dir(self):
+        return self.infos.get("SOURCES_PATH", None)
+
+    @property
+    def from_preset(self):
+        return self.infos.get("PROJECT_FROM_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):
         """
@@ -421,4 +544,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))