Add support for debug

Author: sago35

README.md

@@ -6,19 +6,18 @@ This is a simple extension to add TinyGo support to Visual Studio Code.
 
 ## Features
 
-Right now the only feature this extension supports is setting the right environment variables in the `.vscode/settings.json` of your workspace. For example, it may set the following configuration to work with the [BBC micro:bit](https://microbit.org/):
-
-```json
-{
-    "go.toolsEnvVars": {
-        "GOROOT": "/home/user/.cache/tinygo/goroot-go1.14-f930d5b5f36579e8cbd1c139012b3d702281417fb6bdf67303c4697195b9ef1f-syscall",
-        "GOFLAGS": "-tags=cortexm,baremetal,linux,arm,nrf51822,nrf51,nrf,microbit,tinygo,gc.conservative,scheduler.tasks"
-    }
-}
-```
+The following features are supported.
+
+  * Set the right environment variables in the `.vscode/settings.json` of your workspace
+  * Add support for 'preview' functionality
+  * Add debug settings to `.vscode/settings.json`, `.vscode/launch.json` and `.vscode/tasks.json` of your workspace
 
 To use it, click on the `TinyGo` status bar element at the bottom of the screen and select a target. Alternatively, you could open the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and search for `TinyGo target`.
 
+Debugging can be started via `Run > StartDebugging (F5)`. At this time, debug using openocd is supported. The interface used by openocd can be changed from the following.
+
+![settings](images/settings.png)
+
 Notes:
 
   * It is probably necessary to reload the window once you've set a new TinyGo target. You will be prompted for this if it's necessary.
@@ -30,6 +29,10 @@ This extension depends on the following:
 
   * The [Go extension for VS Code](https://marketplace.visualstudio.com/items?itemName=golang.go). This extension should be automatically installed as a dependency.
   * The TinyGo compiler, version 0.15 or later. See [installation instructions for your operating system](https://tinygo.org/getting-started/).
+  * The [Cortex-Debug extension for VS Code](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug). This extension should be automatically installed as a dependency.
+  * for debug support
+    * The TinyGo compiler, version 0.23 later. See [installation instructions for your operating system](https://tinygo.org/getting-started/).
+    * See [Debugging - Debug Tinygo programs using GDB](https://tinygo.org/docs/guides/debugging/). At least tinygo gdb must work.
 
 ## Development
 

images/settings.png

@@ -1,15 +1,15 @@
 {
 	"name": "vscode-tinygo",
 	"displayName": "TinyGo",
-	"version": "0.3.0",
+	"version": "0.4.0-dev1",
 	"publisher": "tinygo",
 	"description": "TinyGo support for Visual Studio Code",
 	"license": "BSD-3-Clause",
 	"icon": "images/tinygo-logo.png",
 	"categories": [
 		"Programming Languages"
 	],
-	"extensionDependencies": ["golang.go"],
+	"extensionDependencies": ["golang.go", "marus25.cortex-debug"],
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/tinygo-org/vscode-tinygo"
@@ -44,6 +44,16 @@
 					"group": "navigation"
 				}
 			]
+		},
+		"configuration": {
+			"title": "TinyGo Configuration",
+			"properties": {
+				"tinygo.openocdInterface": {
+					"description": "which hardware programmer to use (ex: jlink, cmsis-dap, stlink-v2, ...)",
+					"type": "string",
+					"default": "cmsis-dap"
+				}
+			}
 		}
 	},
 	"scripts": {

package.json

@@ -2,6 +2,9 @@ import * as vscode from 'vscode';
 import * as cp from 'child_process';
 import * as util from 'util';
 import * as preview from './preview';
+import * as path from 'path';
+import * as fs from 'fs';
+import * as os from 'os';
 
 let statusbarItem: vscode.StatusBarItem;
 
@@ -32,6 +35,12 @@ export async function activate(context: vscode.ExtensionContext) {
 	// Register the command, _after_ the list of targets has been read. This
 	// makes sure the user will never see an empty list.
 	let disposable = vscode.commands.registerCommand('vscode-tinygo.selectTarget', async () => {
+		let buildPkg = '';
+		let editor = vscode.window.activeTextEditor;
+		if (editor) {
+			buildPkg = editor.document.fileName;
+		}
+
 		// Load targets (if not already loaded).
 		if (!targets) {
 			targets = await readTargetList(context);
@@ -51,6 +60,10 @@ export async function activate(context: vscode.ExtensionContext) {
 		// Obtain information about this target (GOROOT, build tags).
 		let goroot = '';
 		let buildTags = '';
+		let tinygoroot = '';
+		let openocdInterface = '';
+		let openocdTarget = '';
+		let gdbPath = '';
 		if (target != '-') {
 			try {
 				const execFile = util.promisify(cp.execFile);
@@ -81,6 +94,46 @@ export async function activate(context: vscode.ExtensionContext) {
 				vscode.window.showErrorMessage(`Could not find GOROOT variable for ${target}, perhaps you have an older TinyGo version?`);
 				return;
 			}
+
+			try {
+				const execFile = util.promisify(cp.execFile);
+				const { stdout, stderr } = await execFile('tinygo', ['env', 'TINYGOROOT']);
+				tinygoroot = stdout.trimRight()
+			} catch (err) {
+				vscode.window.showErrorMessage(`Could not run 'tinygo env TINYGOROOT':\n` + err);
+				return;
+			}
+
+			try {
+				openocdInterface = vscode.workspace.getConfiguration('tinygo')['openocdInterface'];
+
+				const execFile = util.promisify(cp.execFile);
+				const { stdout, stderr } = await execFile('tinygo', ['build', '-json', '-target', target, '-o', 'out.elf', '-programmer', openocdInterface]);
+				let buildInfo = JSON.parse(stdout);
+
+				if (buildInfo.Target['openocd-target']) {
+					openocdTarget = buildInfo.Target['openocd-target'];
+				}
+				gdbPath = '';
+
+				let pathSep = ':';
+				if (os.platform() == 'win32') {
+					pathSep = ';';
+				}
+				process.env.PATH?.split(pathSep).forEach(line => {
+					for (var i in buildInfo.Target.gdb) {
+						let g = path.join(line, buildInfo.Target.gdb[i])
+						if (os.platform() == 'win32') {
+							g += '.exe';
+						}
+						if (fs.existsSync(g)) {
+							gdbPath = g;
+						}
+					}
+				})
+			} catch (err) {
+				vscode.window.showErrorMessage(`Could not run 'tinygo build -json -target ${target}':\n` + err);
+			}
 		}
 
 		// Update the configuration in the current workspace.
@@ -89,8 +142,98 @@ export async function activate(context: vscode.ExtensionContext) {
 		let envVars = config.get<NodeJS.Dict<string>>('toolsEnvVars', {});
 		envVars.GOROOT = goroot ? goroot: undefined;
 		envVars.GOFLAGS = buildTags ? "-tags="+(buildTags.split(' ').join(',')) : undefined;
+		envVars.TARGET = target;
+		envVars.TINYGOROOT = tinygoroot;
+		envVars.GdbPath = path.basename(gdbPath);
+		envVars.OpenocdInterface = openocdInterface;
+		envVars.OpenocdTarget = openocdTarget;
+		envVars.TmpDir = os.tmpdir();
+
+		{
+			let folders = vscode.workspace.workspaceFolders
+			if (folders) {
+				let g = folders[0].uri;
+				buildPkg = path.dirname(path.relative(folders[0].uri.fsPath, buildPkg));
+			}
+			envVars.TargetPkg = "./" + buildPkg;
+		}
 		config.update('toolsEnvVars', envVars, vscode.ConfigurationTarget.Workspace);
 
+		{
+			const config = vscode.workspace.getConfiguration('cortex-debug', null);
+			config.update('armToolchainPath', path.dirname(gdbPath));
+			config.update('gdbPath', path.basename(gdbPath));
+		}
+
+		{
+			// launch.json configuration
+			const launchConfig = vscode.workspace.getConfiguration('launch');
+			const configurations = launchConfig['configurations'];
+			let found = false
+			for (var i in configurations) {
+				let cfg = configurations[i];
+				if (cfg.name == 'tinygo-debug') {
+					found = true;
+				}
+			}
+
+			if (!found) {
+				configurations.push({
+					"name": "tinygo-debug",
+					"type": "cortex-debug",
+					"servertype": "openocd",
+					"request": "launch",
+					"runToEntryPoint": "main.main",
+					"executable": "${config:go.toolsEnvVars.TmpDir}/out.elf",
+					"configFiles": [
+						"interface/${config:go.toolsEnvVars.OpenocdInterface}.cfg",
+						"target/${config:go.toolsEnvVars.OpenocdTarget}.cfg"
+					],
+					"preLaunchTask": "tinygo build task",
+					"cwd": "${workspaceRoot}",
+					"gdbPath": "${config:go.toolsEnvVars.GdbPath}",
+				});
+				launchConfig.update('configurations', configurations, false).then(() =>
+					vscode.window.showInformationMessage('Added tinygo configuration to launch.json!')
+				);
+			}
+		}
+
+		{
+			// tasks.json configuration
+			const tasksConfig = vscode.workspace.getConfiguration('tasks');
+			const task = {
+				"label": "tinygo build task",
+				"type": "shell",
+				"command": "tinygo build -o ${config:go.toolsEnvVars.TmpDir}/out.elf -target ${config:go.toolsEnvVars.TARGET} -size short -opt 1 ${config:go.toolsEnvVars.TargetPkg}",
+				"problemMatcher": [],
+				"group": {
+					"kind": "build",
+					"isDefault": true
+				}
+			};
+			if (!tasksConfig['tasks']) {
+				tasksConfig.update('tasks', [task]).then(() =>
+					vscode.window.showInformationMessage('Added tinygo configuration to tasks.json!')
+				);
+			} else {
+				let configurations = tasksConfig['tasks'];
+				let found = false
+				for (var i in configurations) {
+					let cfg = configurations[i];
+					if (cfg.label == 'tinygo build task') {
+						found = true;
+					}
+				}
+				if (!found) {
+					configurations.push(task);
+					tasksConfig.update('tasks', configurations, false).then(() =>
+						vscode.window.showInformationMessage('Added tinygo configuration to tasks.json!')
+					);
+				}
+			}
+		}
+
 		// Update status bar.
 		context.workspaceState.update('tinygo-target', target);
 		updateStatusBar();