Add support for parametrization of the sources dir and the project sources dir.
[bertos.git] / wizard / BProject.py
index f829d335b2a48279fcff31cda61bc78d3494d76b..3129857e3fa8ffcf46b409209a6d6dd6443fc073 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,
@@ -82,13 +82,27 @@ 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)
+        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
+            # Ignore the SOURCES_PATH inside the project file for older project
             project_data["SOURCES_PATH"] = project_dir
+        else:
+            linked_sources_path = project_data["SOURCES_PATH"]
+            sources_abspath = os.path.abspath(os.path.join(project_dir, linked_sources_path))
+            project_data["SOURCES_PATH"] = sources_abspath
+        
         self._loadBertosSourceStuff(project_data["SOURCES_PATH"], info_dict.get("SOURCES_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):
@@ -152,14 +166,27 @@ class BProject(object):
         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"]
-        self.infos["PROJECT_NAME"] = project_data.get("PROJECT_NAME", os.path.basename(preset))
+        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_PATH"] = old_project_path
+        self.infos["PROJECT_SRC_PATH"] = old_project_src_path
+
+        self.infos["PRESET_NAME"] = preset_project_name
+        self.infos["PRESET_PATH"] = preset
+        self.infos["PRESET_SRC_PATH"] = preset_prj_src_path
 
     def loadProjectPresets(self):
         """
@@ -174,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):
@@ -224,12 +251,11 @@ class BProject(object):
                             raise DefineException.ConfigurationDefineException(self.infos["SOURCES_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:
@@ -252,7 +278,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):
@@ -276,30 +302,32 @@ class BProject(object):
                 self._newCustomBertosProject()
             else:
                 self._newBertosProjectFromPreset()
-    
+
     def _newBertosProject(self):
-        for directory in (self.maindir, self.srcdir, self.prjdir, self.hwdir, self.cfgdir):
+        for directory in (self.maindir, self.srcdir, self.prjdir, self.cfgdir):
             self._createDirectory(directory)
         # Write the project file
-        self._writeProjectFile(self.maindir + "/project.bertos")
+        self._writeProjectFile(os.path.join(self.maindir, "project.bertos"))
         # VERSION file
-        self._writeVersionFile(self.maindir + "/VERSION")
+        self._writeVersionFile(os.path.join(self.maindir, "VERSION"))
         # Destination makefile
-        self._writeMakefile(self.maindir + "/Makefile")
+        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(self.prjdir + "/" + os.path.basename(self.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()
+        # 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
@@ -310,22 +338,24 @@ class BProject(object):
     def _newBertosProjectFromPreset(self):
         # Create/write/copy the common things
         self._newBertosProject()
-        # Copy the user mk predefined file
-        # TODO: implement it!
-        
-        # Copy the main.c file (if the user doesn't check the empty main checkbox)
-        # TODO: implement it!
-        
+
+        # 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(self.maindir + "/project.bertos")
+        self._writeProjectFile(os.path.join(self.maindir, "project.bertos"))
         # VERSION file
-        self._writeVersionFile(self.maindir + "/VERSION")
+        self._writeVersionFile(os.path.join(self.maindir, "VERSION"))
         # Destination makefile
-        self._writeMakefile(self.maindir + "/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
@@ -335,7 +365,7 @@ class BProject(object):
         # Copy all the configuration files
         self._writeCfgFiles(self.sources_dir, self.cfgdir)
         # Destination wizard mk file
-        self._writeWizardMkFile(self.prjdir + "/" + os.path.basename(self.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()
 
@@ -357,7 +387,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)
 
@@ -384,7 +414,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():
@@ -397,10 +427,28 @@ 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):
+        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["PROJECT_NAME"] + "_wiz.mk",
+            "project.bertos",
+            self.infos["PROJECT_NAME"] + ".project",
+            self.infos["PROJECT_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"] != "":
@@ -414,7 +462,7 @@ class BProject(object):
     @property
     def maindir(self):
         return self.infos.get("PROJECT_PATH", None)
-    
+
     @property
     def srcdir(self):
         if self.maindir:
@@ -424,22 +472,19 @@ class BProject(object):
 
     @property
     def prjdir(self):
-        if self.maindir:
-            return os.path.join(self.maindir, self.infos["PROJECT_NAME"])
-        else:
-            return None
+        return self.infos.get("PROJECT_SRC_PATH", None)
 
     @property
     def hwdir(self):
         if self.prjdir:
-            return os.path.join(self.prjdir, 'hw')
+            return os.path.join(self.prjdir, "hw")
         else:
             return None
 
     @property
     def cfgdir(self):
         if self.prjdir:
-            return os.path.join(self.prjdir, 'cfg')
+            return os.path.join(self.prjdir, "cfg")
         else:
             return None
 
@@ -459,12 +504,12 @@ class BProject(object):
         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):
@@ -527,4 +572,4 @@ class BProject(object):
         self.infos["FILES"] = files
 
     def __repr__(self):
-        return '<BProject:instance %d>%s' %(id(self), repr(self.infos))
+        return "<BProject:instance %d>%s" %(id(self), repr(self.infos))