Added 'updateWorkspaceFile.py'.

Updated README_DETAILS.md.
Updated SVD and CFG path description.

Author: schperplata

README_DETAILS.md

@@ -16,6 +16,9 @@ If any of files/paths are missing or invalid, new ones are created (and backup f
 
 File adds 'print-variable' function to 'Makefile', while creating a backup 'Makefile'. Function is needed for fetching data from 'Makefile' with (example) 'make print-CFLAGS' call.
 
+## updateWorkspaceFile.py
+This file adds "cortex-debug" keys to '*.code-workspace' file. It is needed for Cortex-Debug extension and should not be modified by user. Instead, this fields are fetched from 'buildData.json' file.
+
 ## updateMakefile.py
 This script generate new 'Makefile' from old 'Makefile' and user data. User data specified in 'c_cpp_properties.json' is merged with existing data from 'Makefile' and stored into 'buildData.json'. New 'Makefile' is created by making a copy and appending specific strings (c/asm sources, includes and defines) with proper multi-line escaping ( '\\' ).
 

ideScripts/update.py

@@ -18,6 +18,7 @@
 import updateBuildData as build
 import updateTasks as tasks
 import updateLaunchConfig as launch
+import updateWorkspaceFile as workspaceFile
 
 
 __version__ = utils.__version__
@@ -79,3 +80,10 @@
     launchData = launch.getLaunchData()
     launchData = launch.addAllLaunchConfigurations(launchData)
     launch.overwriteLaunchFile(launchData)
+
+    # update workspace file with "cortex-debug" specifics
+    wksFile = workspaceFile.UpdateWorkspaceFile()
+    wksFile.checkWorkspaceFile()
+    wksData = wksFile.getWorkspaceFileData()
+    wksData = wksFile.addBuildDataToWorkspaceFile(wksData, buildData)
+    wksFile.overwriteWorkspaceFile(wksData)

ideScripts/updatePaths.py

@@ -23,8 +23,8 @@ def __init__(self):
             (self.bStr.gccExePath, "arm-none-eabi-gcc.exe"),
             (self.bStr.buildToolsPath, "make.exe"),
             (self.bStr.openOCDPath, "openocd.exe"),
-            (self.bStr.openOCDTargetPath, "STM target '*.cfg' file (example: stm32f0x.cfg)"),
-            (self.bStr.stm32svdPath, "STM target '*.svd' file (example: STM32F0x8.svd)")
+            (self.bStr.openOCDTargetPath, "STM target '*.cfg' file (example: ...scripts/target/stm32f0x.cfg)"),
+            (self.bStr.stm32svdPath, "STM target '*.svd' file (example: .../Keil*/CMSIS/SVD/STM32F0x8.svd)")
         ]
 
     def forceUpdatePaths(self, buildData):

ideScripts/updateWorkspaceFile.py

@@ -0,0 +1,105 @@
+'''
+Update existing workspace file with debug paths in "settings":
+    - "cortex-debug.armToolchainPath"
+    - "cortex-debug.openocdPath"
+'''
+import os
+import json
+import datetime
+
+import utilities as utils
+import updatePaths as pth
+import updateBuildData as build
+
+__version__ = utils.__version__
+
+
+class UpdateWorkspaceFile():
+    def __init__(self):
+        self.bStr = build.BuildDataStrings()
+
+    def checkWorkspaceFile(self):
+        '''
+        Check if workspace '*.code-workspace' file exists. If it does, check if it is a valid JSON file.
+        If it doesn't exist report error and quit.
+        '''
+        workspaceFileName = utils.getWorkspaceName()
+        if utils.fileFolderExists(utils.workspaceFilePath):
+            # file exists, check if it loads OK
+            try:
+                with open(utils.workspaceFilePath, 'r') as workspaceFile:
+                    workspaceFileData = json.load(workspaceFile)
+
+                    print("Existing " + workspaceFileName + " file found.")
+
+            except Exception as err:
+                errorMsg = "Invalid " + workspaceFileName + " file.\n"
+                errorMsg += "Possible cause: invalid json format or comments (not supported by this scripts). Error:\n"
+                errorMsg += str(err)
+                print(errorMsg)
+
+        # else: verified in 'utils.verifyFolderStructure()'
+
+    def getWorkspaceFileData(self):
+        '''
+        Get data from current '*.code-workspace' file.
+        File existance is previoulsy checked in 'checkWorkspaceFile()'.
+        '''
+        with open(utils.workspaceFilePath, 'r') as workspaceFile:
+            data = json.load(workspaceFile)
+
+        return data
+
+    def addBuildDataToWorkspaceFile(self, workspaceData, buildData):
+        '''
+        This function ads "cortex-debug.*" items to workspace file, if they don't exist yet.
+        Returns new data.
+        '''
+        armToolchainPath = os.path.dirname(buildData[self.bStr.gccExePath])
+        armToolchainPath = utils.pathWithForwardSlashes(armToolchainPath)
+
+        workspaceData["settings"]["cortex-debug.armToolchainPath"] = armToolchainPath
+        workspaceData["settings"]["cortex-debug.openocdPath"] = buildData[self.bStr.openOCDPath]
+
+        return workspaceData
+
+    def overwriteWorkspaceFile(self, data):
+        '''
+        Overwrite existing '*.code-workspace' file with new data.
+        '''
+        try:
+            with open(utils.workspaceFilePath, 'r+') as workspaceFile:
+                workspaceFile.seek(0)
+                workspaceFile.truncate()
+                dataToWrite = json.dumps(data, indent=4, sort_keys=False)
+                workspaceFile.write(dataToWrite)
+
+            print("'*.code-workspace' file updated!")
+
+        except Exception as err:
+            errorMsg = "Exception error overwriting '*.code-workspace' file:\n"
+            errorMsg += str(err)
+            utils.printAndQuit(errorMsg)
+
+
+
+########################################################################################################################
+if __name__ == "__main__":
+    utils.verifyFolderStructure()
+
+    paths = pth.UpdatePaths()
+    bData = build.BuildData()
+    wksFile = UpdateWorkspaceFile()
+
+    # build data (update tools paths if neccessary)
+    bData.checkBuildDataFile()
+    buildData = bData.getBuildData()
+    if not paths.verifyExistingPaths(buildData):
+        buildData = paths.forceUpdatePaths(buildData)
+        bData.overwriteBuildDataFile(buildData)
+
+    wksFile.checkWorkspaceFile()
+    wksData = wksFile.getWorkspaceFileData()
+    wksData = wksFile.addBuildDataToWorkspaceFile(wksData, buildData)
+
+    wksFile.overwriteWorkspaceFile(wksData)