Merge pull request #100 from bcmi-labs/debugger-cli

Debugger implementation based on arduino-cli debug command

Author: Roberto Sora

.vscode/launch.json

@@ -10,6 +10,13 @@
       "name": "Attach by Process ID",
       "processId": "${command:PickProcess}"
     },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Electron Packager",
+      "program": "${workspaceRoot}/electron/packager/index.js",
+      "cwd": "${workspaceFolder}/electron/packager"
+    },
     {
       "type": "node",
       "request": "launch",
@@ -99,13 +106,6 @@
       "smartStep": true,
       "internalConsoleOptions": "openOnSessionStart",
       "outputCapture": "std"
-    },
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Packager",
-      "program": "${workspaceRoot}/electron/packager/index.js",
-      "cwd": "${workspaceFolder}/electron/packager"
     }
   ]
 }

arduino-debugger-extension/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "arduino-debugger-extension",
+  "version": "0.0.4",
+  "description": "An extension for debugging Arduino programs",
+  "license": "MIT",
+  "engines": {
+    "node": ">=10.10.0"
+  },
+  "dependencies": {
+    "@theia/debug": "next",
+    "arduino-ide-extension": "0.0.4",
+    "cdt-gdb-adapter": "^0.0.14",
+    "vscode-debugadapter": "^1.26.0",
+    "vscode-debugprotocol": "^1.26.0"
+  },
+  "scripts": {
+    "prepare": "yarn run clean && yarn run build",
+    "clean": "rimraf lib",
+    "lint": "tslint -c ./tslint.json --project ./tsconfig.json",
+    "build": "tsc && yarn lint",
+    "watch": "tsc -w"
+  },
+  "devDependencies": {
+    "rimraf": "^2.6.1",
+    "tslint": "^5.5.0",
+    "typescript": "3.5.1"
+  },
+  "files": [
+    "lib",
+    "src",
+    "build",
+    "data"
+  ],
+  "theiaExtensions": [
+    {
+      "backend": "lib/node/backend-module",
+      "frontend": "lib/browser/frontend-module"
+    }
+  ]
+}

arduino-debugger-extension/src/browser/arduino-debug-configuration-manager.ts

@@ -0,0 +1,39 @@
+import { DebugConfigurationManager } from "@theia/debug/lib/browser/debug-configuration-manager";
+import { injectable } from "inversify";
+
+@injectable()
+export class ArduinoDebugConfigurationManager extends DebugConfigurationManager {
+
+    get defaultDebugger(): Promise<string | undefined> {
+        return this.debug.getDebuggersForLanguage('ino').then(debuggers => {
+            if (debuggers.length === 0)
+                return undefined;
+            return debuggers[0].type;
+        });
+    }
+
+    protected async selectDebugType(): Promise<string | undefined> {
+        const widget = this.editorManager.currentEditor;
+        if (!widget) {
+            return this.defaultDebugger;
+        }
+        const { languageId } = widget.editor.document;
+        const debuggers = await this.debug.getDebuggersForLanguage(languageId);
+        if (debuggers.length === 0) {
+            return this.defaultDebugger;
+        }
+        return this.quickPick.show(debuggers.map(
+            ({ label, type }) => ({ label, value: type }),
+            { placeholder: 'Select Environment' })
+        );
+    }
+
+    async createDefaultConfiguration(): Promise<void> {
+        const { model } = this;
+        if (model) {
+            await this.doCreate(model);
+            await this.updateModels();
+        }
+    }
+
+}

arduino-debugger-extension/src/browser/arduino-debug-frontend-application-contribution.ts

@@ -0,0 +1,133 @@
+import { injectable, inject } from 'inversify';
+import { MenuModelRegistry, Path, MessageService, Command, CommandRegistry } from '@theia/core';
+import { KeybindingRegistry } from '@theia/core/lib/browser';
+import { TabBarToolbarRegistry } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
+import { DebugFrontendApplicationContribution, DebugCommands } from '@theia/debug/lib/browser/debug-frontend-application-contribution';
+import { DebugSessionOptions } from "@theia/debug/lib/browser/debug-session-options";
+import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
+import { FileSystem } from '@theia/filesystem/lib/common';
+import URI from '@theia/core/lib/common/uri';
+import { EditorManager } from '@theia/editor/lib/browser';
+import { EditorMode } from "arduino-ide-extension/lib/browser/editor-mode";
+import { SketchesService } from 'arduino-ide-extension/lib/common/protocol/sketches-service';
+import { ArduinoToolbar } from 'arduino-ide-extension/lib/browser/toolbar/arduino-toolbar';
+import { ArduinoDebugConfigurationManager } from './arduino-debug-configuration-manager';
+
+export namespace ArduinoDebugCommands {
+    export const START_DEBUG: Command = {
+        id: 'arduino-start-debug',
+        label: 'Start Debugging'
+    }
+}
+
+@injectable()
+export class ArduinoDebugFrontendApplicationContribution extends DebugFrontendApplicationContribution {
+
+    @inject(EditorMode)
+    protected readonly editorMode: EditorMode;
+
+    @inject(WorkspaceService)
+    protected readonly workspaceService: WorkspaceService;
+
+    @inject(SketchesService)
+    protected readonly sketchesService: SketchesService;
+
+    @inject(FileSystem)
+    protected readonly fileSystem: FileSystem;
+
+    @inject(EditorManager)
+    protected readonly editorManager: EditorManager;
+
+    @inject(MessageService)
+    protected readonly messageService: MessageService;
+
+    async start(noDebug?: boolean, debugSessionOptions?: DebugSessionOptions): Promise<void> {
+        const configurations = this.configurations as ArduinoDebugConfigurationManager;
+        let current = debugSessionOptions ? debugSessionOptions : configurations.current;
+        // If no configurations are currently present, create them
+        if (!current) {
+            await configurations.createDefaultConfiguration();
+            current = configurations.current;
+        }
+        if (current) {
+            if (noDebug !== undefined) {
+                current = {
+                    ...current,
+                    configuration: {
+                        ...current.configuration,
+                        noDebug
+                    }
+                };
+            }
+            if (current.configuration.type === 'arduino') {
+                const wsStat = this.workspaceService.workspace;
+                let sketchFileURI: URI | undefined;
+                if (wsStat && await this.sketchesService.isSketchFolder(wsStat.uri)) {
+                    const wsPath = new Path(wsStat.uri);
+                    const sketchFilePath = wsPath.join(wsPath.name + '.ino').toString();
+                    sketchFileURI = new URI(sketchFilePath);
+                } else if (this.editorManager.currentEditor) {
+                    const editorURI = this.editorManager.currentEditor.getResourceUri();
+                    if (editorURI && editorURI.path && editorURI.path.ext === '.ino') {
+                        sketchFileURI = editorURI;
+                    }
+                }
+                if (sketchFileURI) {
+                    await this.editorManager.open(sketchFileURI);
+                    await this.manager.start(current);
+                } else {
+                    this.messageService.error('Please open a sketch file to start debugging.')
+                }
+            } else {
+                await this.manager.start(current);
+            }
+        }
+    }
+
+    initializeLayout(): Promise<void> {
+        if (this.editorMode.proMode) {
+            return super.initializeLayout();
+        }
+        return Promise.resolve();
+    }
+
+    registerMenus(menus: MenuModelRegistry): void {
+        if (this.editorMode.proMode) {
+            super.registerMenus(menus);
+            menus.unregisterMenuAction(DebugCommands.START_NO_DEBUG);
+        }
+    }
+
+    registerKeybindings(keybindings: KeybindingRegistry): void {
+        if (this.editorMode.proMode) {
+            super.registerKeybindings(keybindings);
+            keybindings.unregisterKeybinding({
+                command: DebugCommands.START_NO_DEBUG.id,
+                keybinding: 'ctrl+f5'
+            });
+        }
+    }
+
+    registerToolbarItems(toolbar: TabBarToolbarRegistry): void {
+        super.registerToolbarItems(toolbar);
+        toolbar.registerItem({
+            id: ArduinoDebugCommands.START_DEBUG.id,
+            command: ArduinoDebugCommands.START_DEBUG.id,
+            tooltip: 'Start Debugging',
+            priority: 1
+        });
+    }
+
+    registerCommands(registry: CommandRegistry): void {
+        super.registerCommands(registry);
+        registry.registerCommand(ArduinoDebugCommands.START_DEBUG, {
+            isVisible: widget => ArduinoToolbar.is(widget) && widget.side === 'left',
+            isEnabled: widget => ArduinoToolbar.is(widget) && widget.side === 'left',
+            execute: () => {
+                registry.executeCommand(DebugCommands.START.id);
+            }
+        });
+    }
+
+
+}

arduino-debugger-extension/src/browser/arduino-debug-session-manager.ts

@@ -0,0 +1,14 @@
+import { DebugSessionManager } from "@theia/debug/lib/browser/debug-session-manager";
+import { DebugSessionOptions } from "@theia/debug/lib/browser/debug-session-options";
+
+export class ArduinoDebugSessionManager extends DebugSessionManager {
+
+    start(options: DebugSessionOptions) {
+        if (options.configuration.type === 'arduino' && this.sessions.find(s => s.configuration.type === 'arduino')) {
+            this.messageService.info('A debug session is already running. You must stop the running session before starting a new one.')
+            return Promise.resolve(undefined);
+        }
+        return super.start(options);
+    }
+
+}

arduino-debugger-extension/src/browser/arduino-variable-resolver.ts

@@ -0,0 +1,46 @@
+
+import { VariableContribution, VariableRegistry, Variable } from '@theia/variable-resolver/lib/browser';
+import { injectable, inject } from 'inversify';
+import { MessageService } from '@theia/core/lib/common/message-service';
+import { BoardsServiceClientImpl } from 'arduino-ide-extension/lib/browser/boards/boards-service-client-impl';
+
+@injectable()
+export class ArduinoVariableResolver implements VariableContribution {
+
+    @inject(BoardsServiceClientImpl)
+    protected readonly boardsServiceClient: BoardsServiceClientImpl;
+
+    @inject(MessageService)
+    protected readonly messageService: MessageService
+
+    registerVariables(variables: VariableRegistry): void {
+        variables.registerVariable(<Variable>{
+            name: 'fqbn',
+            description: 'Qualified name of the selected board',
+            resolve: this.resolveFqbn.bind(this),
+        });
+        variables.registerVariable({
+            name: 'port',
+            description: 'Selected upload port',
+            resolve: this.resolvePort.bind(this)
+        });
+    }
+
+    protected async resolveFqbn(): Promise<string | undefined> {
+        const { boardsConfig } = this.boardsServiceClient;
+        if (!boardsConfig || !boardsConfig.selectedBoard) {
+            this.messageService.error('No board selected. Please select a board for debugging.');
+            return undefined;
+        }
+        return boardsConfig.selectedBoard.fqbn;
+    }
+
+    protected async resolvePort(): Promise<string | undefined> {
+        const { boardsConfig } = this.boardsServiceClient;
+        if (!boardsConfig || !boardsConfig.selectedPort) {
+            return undefined;
+        }
+        return boardsConfig.selectedPort.address;
+    }
+
+}

arduino-debugger-extension/src/browser/frontend-module.ts

@@ -0,0 +1,20 @@
+import { ContainerModule } from 'inversify';
+import { VariableContribution } from '@theia/variable-resolver/lib/browser';
+import { ArduinoVariableResolver } from './arduino-variable-resolver';
+import { DebugSessionManager } from '@theia/debug/lib/browser/debug-session-manager';
+import { DebugFrontendApplicationContribution } from '@theia/debug/lib/browser/debug-frontend-application-contribution';
+import { DebugConfigurationManager } from '@theia/debug/lib/browser/debug-configuration-manager';
+import { ArduinoDebugConfigurationManager } from './arduino-debug-configuration-manager';
+import { ArduinoDebugFrontendApplicationContribution } from './arduino-debug-frontend-application-contribution';
+import { ArduinoDebugSessionManager } from './arduino-debug-session-manager';
+
+import '../../src/browser/style/index.css';
+
+
+export default new ContainerModule((bind, unbind, isBound, rebind) => {
+    bind(ArduinoVariableResolver).toSelf().inSingletonScope();
+    bind(VariableContribution).toService(ArduinoVariableResolver);
+    rebind(DebugSessionManager).to(ArduinoDebugSessionManager).inSingletonScope();
+    rebind(DebugConfigurationManager).to(ArduinoDebugConfigurationManager).inSingletonScope();
+    rebind(DebugFrontendApplicationContribution).to(ArduinoDebugFrontendApplicationContribution);
+});

arduino-debugger-extension/src/browser/style/debug-dark.svg

@@ -0,0 +1,16 @@
+.arduino-start-debug-icon {
+    -webkit-mask: url('debug-dark.svg') 50%;
+    mask: url('debug-dark.svg') 50%;
+    -webkit-mask-size: 100%;
+    mask-size: 100%;
+    -webkit-mask-repeat: no-repeat;
+    mask-repeat: no-repeat;
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    color: var(--theia-ui-button-font-color);
+}
+
+.arduino-start-debug {
+    border-radius: 12px;
+}