Merge pull request #3679 from sg-/feature-vscode

Feature vscode

Author: sg-

tools/export/__init__.py

@@ -17,7 +17,7 @@
 
 from tools.export import codered, ds5_5, iar, makefile
 from tools.export import embitz, coide, kds, simplicity, atmelstudio
-from tools.export import sw4stm32, e2studio, zip, cmsis, uvision, cdt
+from tools.export import sw4stm32, e2studio, zip, cmsis, uvision, cdt, vscode
 from tools.targets import TARGET_NAMES
 
 EXPORTERS = {
@@ -41,7 +41,10 @@
     'eclipse_iar'      : cdt.EclipseIAR,
     'eclipse_armc5'    : cdt.EclipseArmc5,
     'zip' : zip.ZIP,
-    'cmsis'    : cmsis.CMSIS
+    'cmsis'    : cmsis.CMSIS,
+    'vscode_gcc_arm' : vscode.VSCodeGcc,
+    'vscode_iar' : vscode.VSCodeIAR,
+    'vscode_armc5' : vscode.VSCodeArmc5
 }
 
 ERROR_MESSAGE_UNSUPPORTED_TOOLCHAIN = """

tools/export/vscode/__init__.py

@@ -0,0 +1,46 @@
+from os.path import join, exists, realpath, relpath, basename
+from os import makedirs
+
+from tools.export.makefile import Makefile, GccArm, Armc5, IAR
+
+class VSCode(Makefile):
+    """Generic VSCode project. Intended to be subclassed by classes that
+    specify a type of Makefile.
+    """
+    def generate(self):
+        """Generate Makefile and VSCode launch and task files
+        """
+        super(VSCode, self).generate()
+        ctx = {
+            'name': self.project_name,
+            'elf_location': join('BUILD', self.project_name)+'.elf',
+            'c_symbols': self.toolchain.get_symbols(),
+            'asm_symbols': self.toolchain.get_symbols(True),
+            'target': self.target,
+            'include_paths': self.resources.inc_dirs,
+            'load_exe': str(self.LOAD_EXE).lower()
+        }
+
+        if not exists(join(self.export_dir, '.vscode')):
+            makedirs(join(self.export_dir, '.vscode'))
+
+
+        self.gen_file('vscode/tasks.tmpl', ctx,
+                      join('.vscode', 'tasks.json'))
+        self.gen_file('vscode/launch.tmpl', ctx,
+                      join('.vscode', 'launch.json'))
+
+
+class VSCodeGcc(VSCode, GccArm):
+    LOAD_EXE = True
+    NAME = "VSCode-GCC-ARM"
+
+class VSCodeArmc5(VSCode, Armc5):
+    LOAD_EXE = True
+    NAME = "VSCode-Armc5"
+
+class VSCodeIAR(VSCode, IAR):
+    LOAD_EXE = True
+    NAME = "VSCode-IAR"
+
+

tools/export/vscode/launch.tmpl

@@ -0,0 +1,58 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "C++ Launch",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "${workspaceRoot}/BUILD/${workspaceRootFolderName}.elf",
+            "args": [],
+            "stopAtEntry": true,
+            "cwd": "${workspaceRoot}",
+            "environment": [],
+            "externalConsole": false,
+            "debugServerArgs": "",
+            "serverLaunchTimeout": 20000,
+            "filterStderr": true,
+            "filterStdout": false,
+            "serverStarted": "GDB\\ server\\ started",
+            "preLaunchTask": "make",
+            "setupCommands": [
+                { "text": "-target-select remote localhost:3333", "description": "connect to target", "ignoreFailures": false },
+                { "text": "-file-exec-and-symbols ${workspaceRoot}/BUILD/${workspaceRootFolderName}.elf", "description": "load file", "ignoreFailures": false},
+                { "text": "-interpreter-exec console \"monitor endian little\"", "ignoreFailures": false },
+                { "text": "-interpreter-exec console \"monitor reset\"", "ignoreFailures": false },
+                { "text": "-interpreter-exec console \"monitor halt\"", "ignoreFailures": false },
+                { "text": "-interpreter-exec console \"monitor arm semihosting enable\"", "ignoreFailures": false },
+                { "text": "-target-download", "description": "flash target", "ignoreFailures": false }
+            ],
+            "logging": {
+                "moduleLoad": true,
+                "trace": true,
+                "engineLogging": true,
+                "programOutput": true,
+                "exceptions": true
+            },
+            "linux": {
+                "MIMode": "gdb",
+                "MIDebuggerPath": "/usr/bin/arm-none-eabi-gdb",
+                "debugServerPath": "/usr/local/bin/pyocd-gdbserver"
+            },
+            "osx": {
+                "MIMode": "gdb",
+                "MIDebuggerPath": "/usr/local/bin/arm-none-eabi-gdb",
+                "debugServerPath": "/usr/local/bin/pyocd-gdbserver"
+            },
+            "windows": {
+                "MIMode": "gdb",
+                "MIDebuggerPath": "${workspaceRoot}\\.vscode\\bin\\windows\\gcc\\arm-none-eabi-gdb.exe",
+                "debugServerPath": "${workspaceRoot}\\.vscode\\bin\\windows\\gdb_server.exe",
+                "setupCommands": [
+                    { "text": "-target-select remote localhost:3333", "description": "connect to target", "ignoreFailures": false },
+                    { "text": "-file-exec-and-symbols z:\\\\mbed-os-example-blinky\\\\BUILD\\\\${workspaceRootFolderName}.elf", "description": "load file", "ignoreFailures": false},
+                    { "text": "-target-download", "description": "flash target", "ignoreFailures": false }
+                ]
+            }
+        }
+    ]
+}

tools/export/vscode/tasks.tmpl

@@ -0,0 +1,35 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "0.1.0",
+    "isShellCommand": true,
+    "showOutput": "always",,
+    "tasks": [
+        {
+            "taskName": "make",
+            "problemMatcher": {
+                "owner": "cpp",
+                "fileLocation": ["relative", "${workspaceRoot}/mbed-os"],
+                "pattern": {
+                    "regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$",
+                    "file": 1,
+                    "line": 2,
+                    "column": 3,
+                    "severity": 4,
+                    "message": 5
+                }
+            }
+        }
+    ],
+    "linux": {
+        "command": "make",
+        "args": ["-j"]
+    },
+    "osx": {
+        "command": "make",
+        "args": ["-j"]
+    },
+    "windows": {
+        "command": "${workspaceRoot}\\.vscode\\bin\\windows\\make.bat"
+    }
+}

tools/export/vscode/vscode.md

@@ -0,0 +1,37 @@
+# VSCode exporter
+Exporting for Microsoft Visual Studio code works on Windows, Mac and Linux but will expect a few system dependnecies to be installed. The exporter creates task files and launch files that make it easy to compile and debug within the IDE. Building is done using the created makefile. Debugging with GDB and pyOCD
+
+## Setup
+- compiler
+    - GNU ARM Embedded
+    - IAR
+    - ARMC5
+- mbed CLI
+    - mbed tools requirement (pip install -U requirements.txt)
+- make
+
+```
+mbed config [--global] target <board_name>
+mbed export -i vscode_armc5
+mbed export -i vscode_iar
+mbed export -i vscode_gcc_arm
+```
+
+## Quickstart
+- Windows
+    - compile: ctrl + shift + B
+- Mac
+    - compile: cmd + shift + B
+- Linux
+    - compile: ctrl + shift + B
+
+# ToDo
+- launch GDB for Windows
+- verify Linux installation location for pyOCD
+- verify Mac installation location for pyOCD
+- verify Windows installation location for pyOCD
+- document udev rule for pyOCD on Linux
+- .vscode added to .gitignore for all applications etc.
+- filtered code completion in settings.json for the specific target that is exported for
+- keybindings.json for common mbed actions (possibly to match the online IDE key bindings)
+- add pictures!