Use " instead of ' for BProject file (to follow the BeRTOS wizard coding standard).
[bertos.git] / wizard / BProject.py
index 47005c13737caa128bfc8107c5cf1de328e02103..edba9d661c029ecef64ae74ab33da37c4e37d745 100644 (file)
@@ -51,7 +51,7 @@ from bertos_utils import (
                             isBertosDir, getTagSet, getInfos, updateConfigurationValues,
                             loadConfigurationInfos, loadDefineLists, loadModuleDefinition,
                             getCommentList, sub,
-                            
+
                             # Project creation functions
                             projectFileGenerator, versionFileGenerator, makefileGenerator,
                             userMkGenerator, mkGenerator, loadPlugin, mergeSources,
@@ -159,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):
         """
@@ -174,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):
@@ -252,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):
@@ -272,57 +274,76 @@ class BProject(object):
         if self.edit:
             self._editBertosProject()
         else:
-            self._newBertosProject()
-    
+            if not self.from_preset:
+                self._newCustomBertosProject()
+            else:
+                self._newBertosProjectFromPreset()
+
     def _newBertosProject(self):
-        maindir, srcdir, prjdir, hwdir, cfgdir, sources_dir, old_srcdir = self._projectDirectories()
-        for directory in (maindir, srcdir, prjdir, hwdir, cfgdir):
+        for directory in (self.maindir, self.srcdir, self.prjdir, self.hwdir, self.cfgdir):
             self._createDirectory(directory)
         # Write the project file
-        self._writeProjectFile(maindir + "/project.bertos")
+        self._writeProjectFile(os.path.join(self.maindir, "project.bertos"))
         # VERSION file
-        self._writeVersionFile(maindir + "/VERSION")
+        self._writeVersionFile(os.path.join(self.maindir, "VERSION"))
         # Destination makefile
-        self._writeMakefile(maindir + "/Makefile")
+        self._writeMakefile(os.path.join(self.maindir, "Makefile"))
         # Copy the sources
-        self._copySources(sources_dir, srcdir)
+        self._copySources(self.sources_dir, self.srcdir)
         # Copy all the hw files
-        self._writeHwFiles(sources_dir, hwdir)
+        self._writeHwFiles(self.sources_dir, self.hwdir)
         # Set properly the autoenabled parameters
         self._setupAutoenabledParameters()
         # Copy all the configuration files
-        self._writeCfgFiles(sources_dir, cfgdir)
-        # Destination user mk file (only on project creation)
-        self._writeUserMkFile(os.path.join(prjdir, os.path.basename(prjdir) + ".mk"))
+        self._writeCfgFiles(self.sources_dir, self.cfgdir)
         # Destination wizard mk file
-        self._writeWizardMkFile(prjdir + "/" + os.path.basename(prjdir) + "_wiz.mk")
+        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(prjdir + "/main.c")
-        # 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
+        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):
-        maindir, srcdir, prjdir, hwdir, cfgdir, sources_dir, old_srcdir = self._projectDirectories()
         # Write the project file
-        self._writeProjectFile(maindir + "/project.bertos")
+        self._writeProjectFile(os.path.join(self.maindir, "project.bertos"))
         # VERSION file
-        self._writeVersionFile(maindir + "/VERSION")
+        self._writeVersionFile(os.path.join(self.maindir, "VERSION"))
         # Destination makefile
-        self._writeMakefile(maindir + "/Makefile")
+        self._writeMakefile(os.path.join(self.maindir, "Makefile"))
         # Merge sources
-        self._mergeSources(sources_dir, srcdir, old_srcdir)
+        self._mergeSources(self.sources_dir, self.srcdir, self.old_srcdir)
         # Copy all the hw files
-        self._writeHwFiles(sources_dir, hwdir)
+        self._writeHwFiles(self.sources_dir, self.hwdir)
         # Set properly the autoenabled parameters
         self._setupAutoenabledParameters()
         # Copy all the configuration files
-        self._writeCfgFiles(sources_dir, cfgdir)
+        self._writeCfgFiles(self.sources_dir, self.cfgdir)
         # Destination wizard mk file
-        self._writeWizardMkFile(prjdir + "/" + os.path.basename(prjdir) + "_wiz.mk")
+        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"]:
@@ -340,7 +361,7 @@ class BProject(object):
         f.close()
 
     def _writeMakefile(self, filename):
-        makefile = open(os.path.join(const.DATA_DIR, "mktemplates/Makefile"), 'r').read()
+        makefile = open(os.path.join(const.DATA_DIR, "mktemplates/Makefile"), "r").read()
         makefile = makefileGenerator(self, makefile)
         open(filename, "w").write(makefile)
 
@@ -367,7 +388,7 @@ class BProject(object):
                 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(destination_dir + "/" + os.path.basename(hwfile), "w").write(string)
+                    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():
@@ -380,10 +401,23 @@ class BProject(object):
                 if "long" in infos["informations"] and infos["informations"]["long"]:
                     value += "L"
                 string = sub(string, parameter, value)
-            f = open(destination_dir + "/" + os.path.basename(configuration), "w")
+            f = open(os.path.join(destination_dir, os.path.basename(configuration)), "w")
             f.write(string)
             f.close()
 
+    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"] != "":
@@ -394,26 +428,60 @@ class BProject(object):
                         configuration[parameter]["value"] = "1" if information["enabled"] else "0"
                 self.infos["CONFIGURATIONS"] = configurations
 
-    def _projectDirectories(self):
-        maindir = self.infos["PROJECT_PATH"]
-        srcdir =  maindir + "/bertos"
-        prjdir = os.path.join(maindir, self.infos["PROJECT_NAME"])
-        hwdir = prjdir + "/hw"
-        cfgdir = prjdir + "/cfg"
-        old_srcdir = self.infos.get("OLD_SOURCES_PATH", None)
-        sources_dir = self.infos["SOURCES_PATH"]
-        return maindir, srcdir, prjdir, hwdir, cfgdir, sources_dir, old_srcdir
+    @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)        
+            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)        
+        shutil.rmtree(destination, True)
         copytree.copytree(origin + "/bertos", destination, ignore_list=const.IGNORE_LIST)
 
     def _mergeSources(self, origin, destination, old_sources_dir):
@@ -476,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))