Merge pull request #6153 from theotherjimmy/correct-export-clean

Correct exporter clean behavior

Author: cmonr

tools/export/atmelstudio/__init__.py

@@ -16,6 +16,7 @@
 """
 import uuid
 from os.path import splitext, basename, dirname
+from os import remove
 
 from tools.export.exporters import Exporter, deprecated_exporter
 
@@ -83,3 +84,8 @@ def generate(self):
         target = self.target.lower()
         self.gen_file('atmelstudio/atsln.tmpl', ctx, '%s.atsln' % self.project_name)
         self.gen_file('atmelstudio/cppproj.tmpl', ctx, '%s.cppproj' % self.project_name)
+
+    @staticmethod
+    def clean(project_name):
+        remove('%s.atsln' % project_name)
+        remove('%s.cppproj' % project_name)

tools/export/cces/__init__.py

@@ -408,6 +408,12 @@ def generate(self):
 
         print("CCES files generated.")
 
+
+    @staticmethod
+    def clean(_):
+        os.remove('cces.json')
+        os.remove('README.md')
+
     @staticmethod
     def build(project_name, log_name='build_log.txt', cleanup=True):
         """
@@ -436,6 +442,7 @@ def build(project_name, log_name='build_log.txt', cleanup=True):
         # cleanup workspace
         if os.path.exists(workspace):
             shutil.rmtree(workspace, True)
+            CCES.clean(project_name)
 
         # check return code for failure
         if ret_code != 0:

tools/export/cdt/__init__.py

@@ -1,7 +1,8 @@
 import re
 
 from os.path import join, exists
-from os import makedirs
+from os import makedirs, remove
+import shutil
 
 from tools.export.makefile import Makefile, GccArm, Armc5, IAR
 
@@ -39,6 +40,12 @@ def generate(self):
         self.gen_file('cdt/.cproject.tmpl', ctx, '.cproject')
         self.gen_file('cdt/.project.tmpl', ctx, '.project')
 
+    @staticmethod
+    def clean(project_name):
+        shutil.rmtree("eclipse-extras")
+        remove(".cproject")
+        remove(".project")
+
 
 class EclipseGcc(Eclipse, GccArm):
     LOAD_EXE = True

tools/export/cmake/__init__.py

@@ -112,6 +112,15 @@ def generate(self):
         except TemplateNotFound:
             pass
 
+    @staticmethod
+    def clean(_):
+        remove("CMakeLists.txt")
+        # legacy .build directory cleaned if exists
+        if exists('.build'):
+            shutil.rmtree('.build')
+        if exists('BUILD'):
+            shutil.rmtree('BUILD')
+
     @staticmethod
     def build(project_name, log_name="build_log.txt", cleanup=True):
         """ Build Make project """
@@ -162,13 +171,8 @@ def build(project_name, log_name="build_log.txt", cleanup=True):
 
         # Cleanup the exported and built files
         if cleanup:
-            remove("CMakeLists.txt")
             remove(log_name)
-            # legacy .build directory cleaned if exists
-            if exists('.build'):
-                shutil.rmtree('.build')
-            if exists('BUILD'):
-                shutil.rmtree('BUILD')
+            CMake.clean(project_name)
 
         if ret_code != 0:
             # Seems like something went wrong.

tools/export/cmsis/__init__.py

@@ -153,3 +153,8 @@ def generate(self):
             'date': ''
         }
         self.gen_file('cmsis/cpdsc.tmpl', ctx, 'project.cpdsc')
+
+
+    @staticmethod
+    def clean(_):
+        os.remove('project.cpdsc')

tools/export/coide/__init__.py

@@ -15,6 +15,7 @@
 limitations under the License.
 """
 from os.path import splitext, basename
+from os import remove
 
 from tools.export.exporters import Exporter, deprecated_exporter
 
@@ -109,3 +110,7 @@ def generate(self):
 
         # Project file
         self.gen_file('coide/%s.coproj.tmpl' % target, ctx, '%s.coproj' % self.project_name)
+
+    @staticmethod
+    def clean(project_name):
+        remove('%s.coproj' % project_name)

tools/export/e2studio/__init__.py

@@ -14,6 +14,7 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+from os import remove
 from tools.export.gnuarmeclipse import GNUARMEclipse
 
 class E2Studio(GNUARMEclipse):
@@ -39,3 +40,8 @@ def generate(self):
         self.gen_file('gnuarmeclipse/.project.tmpl', jinja_ctx, '.project', trim_blocks=True, lstrip_blocks=True)
         self.gen_file_nonoverwrite('gnuarmeclipse/mbedignore.tmpl', jinja_ctx, '.mbedignore')
         self.gen_file('gnuarmeclipse/makefile.targets.tmpl', jinja_ctx, 'makefile.targets', trim_blocks=True, lstrip_blocks=True)
+
+    @staticmethod
+    def clean(project_name):
+        remove('%s OpenOCD 5x.launch' % project_name)
+        remove('%s OpenOCD.launch' % project_name)

tools/export/embitz/__init__.py

@@ -15,6 +15,7 @@
 limitations under the License.
 """
 from os.path import splitext, basename
+from os import remove
 from tools.targets import TARGET_MAP
 from tools.export.exporters import Exporter, apply_supported_whitelist
 
@@ -87,3 +88,7 @@ def generate(self):
         }
 
         self.gen_file('embitz/eix.tmpl', ctx, '%s.eix' % self.project_name)
+
+    @staticmethod
+    def clean(project_name):
+        remove("%s.eix" % project_name)

tools/export/exporters.py

@@ -50,6 +50,7 @@ class Exporter(object):
     NAME = None
     TARGETS = set()
     TOOLCHAIN = None
+    CLEAN_FILES = ("GettingStarted.html",)
 
 
     def __init__(self, target, export_dir, project_name, toolchain,
@@ -217,12 +218,28 @@ def build(project_name, log_name='build_log.txt', cleanup=True):
 
         Returns -1 on failure and 0 on success
         """
-        raise NotImplemented("Implement in derived Exporter class.")
+        raise NotImplementedError("Implement in derived Exporter class.")
+
+    @staticmethod
+    def clean(project_name):
+        """Clean a previously exported project
+        This method is assumed to be executed at the same level as exporter
+        project files and project source code.
+        See uvision/__init__.py, iar/__init__.py, and makefile/__init__.py for
+        example implemenation.
+
+        Positional Arguments:
+        project_name - the name of the project to build; often required by
+        exporter's build command.
+
+        Returns nothing. May raise exceptions
+        """
+        raise NotImplementedError("Implement in derived Exporter class.")
 
     @abstractmethod
     def generate(self):
         """Generate an IDE/tool specific project file"""
-        raise NotImplemented("Implement a generate function in Exporter child class")
+        raise NotImplementedError("Implement a generate function in Exporter child class")
 
     @classmethod
     def is_target_supported(cls, target_name):

tools/export/gnuarmeclipse/__init__.py

@@ -299,6 +299,17 @@ def generate(self):
         print
         print 'Done. Import the \'{0}\' project in Eclipse.'.format(self.project_name)
 
+    @staticmethod
+    def clean(_):
+        os.remove('.project')
+        os.remove('.cproject')
+        if exists('Debug'):
+            shutil.rmtree('Debug')
+        if exists('Release'):
+            shutil.rmtree('Release')
+        if exists('makefile.targets'):
+            os.remove('makefile.targets')
+
     # override
     @staticmethod
     def build(project_name, log_name="build_log.txt", cleanup=True):
@@ -366,14 +377,6 @@ def build(project_name, log_name="build_log.txt", cleanup=True):
         if cleanup:
             if exists(log_name):
                 os.remove(log_name)
-            os.remove('.project')
-            os.remove('.cproject')
-            if exists('Debug'):
-                shutil.rmtree('Debug')
-            if exists('Release'):
-                shutil.rmtree('Release')
-            if exists('makefile.targets'):
-                os.remove('makefile.targets')
 
         # Always remove the temporary folder.
         if exists(tmp_folder):