Add native Yosys/Nextpnr support

.pre-commit-config.yaml

@@ -1,17 +1,17 @@
 repos:
     - repo: https://github.com/pre-commit/mirrors-prettier
-      rev: v2.7.1
+      rev: v3.1.0
       hooks:
           - id: prettier
             additional_dependencies:
-                - prettier@^2.8.8
-                - '@trivago/prettier-plugin-sort-imports@^4.1.1'
-                - '@vue/compiler-sfc@^3.3.4'
+                - prettier@^2.1.0
+                - '@trivago/prettier-plugin-sort-imports@^4.3.0'
+                - '@vue/compiler-sfc@^3.3.9'
     - repo: https://github.com/pre-commit/mirrors-eslint
-      rev: v8.39.0
+      rev: v8.54.0
       hooks:
           - id: eslint
             additional_dependencies:
-                - eslint@^8.44.0
-                - '@typescript-eslint/eslint-plugin@^5.61.0'
-                - '@typescript-eslint/parser@^5.61.0'
+                - eslint@^8.54.0
+                - '@typescript-eslint/eslint-plugin@^6.12.0'
+                - '@typescript-eslint/parser@^6.12.0'

.vscode/launch.json

@@ -5,9 +5,18 @@
 {
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "Run Extension ",
+            "type": "extensionHost",
+            "debugWebWorkerHost": true,
+            "request": "launch",
+            "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+            "outFiles": ["${workspaceFolder}/dist/extension/**/*.js"],
+            "preLaunchTask": "npm: watch-web"
+        },
         {
             "name": "Run Web Extension ",
-            "type": "pwa-extensionHost",
+            "type": "extensionHost",
             "debugWebWorkerHost": true,
             "request": "launch",
             "args": ["--extensionDevelopmentPath=${workspaceFolder}", "--extensionDevelopmentKind=web"],

package.json

@@ -13,7 +13,6 @@
         "Mike Almeloo <[email protected]>",
         "Hendrik Folmer <[email protected]>"
     ],
-    "type": "module",
     "engines": {
         "vscode": "^1.73.0"
     },
@@ -44,8 +43,19 @@
         "onView:edacation-outputFiles",
         "onView:edacation-actions"
     ],
+    "main": "./dist/extension/extension.js",
     "browser": "./dist/extension/extension.js",
     "contributes": {
+        "configuration": {
+            "title": "EDAcation",
+            "properties": {
+                "edacation.useNativeRunners": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Use native Yosys/Nextpnr binaries installed on the system instead of the bundled WebAssembly binaries."
+                }
+            }
+        },
         "commands": [
             {
                 "command": "edacation.newProject",
@@ -238,7 +248,7 @@
                 {
                     "id": "edacation-actions",
                     "name": "Actions",
-                    "type": "webview"
+                    "_todo_type": "webview"
                 }
             ]
         },
@@ -257,7 +267,7 @@
                 "contents": "No EDA project are open.\n[New Project](command:edacation.newProject)\n[Open Project](command:edacation.openProject)\nTo learn more about how to use EDA projects [read the documentation](https://github.com/EDAcation/vscode-edacation)."
             },
             {
-                "view": "edacation-actions-old",
+                "view": "edacation-actions",
                 "contents": "[Open Configuration](command:edacation.openProjectConfiguration)\n[Show RTL](command:edacation.runRTL)\n[Synthesize using Yosys](command:edacation.runYosys)\n[Place and Route using nextpnr](command:edacation.runNextpnr)\n"
             }
         ]
@@ -275,28 +285,28 @@
         "pretest": "npm run compile-web"
     },
     "devDependencies": {
-        "@trivago/prettier-plugin-sort-imports": "^4.1.1",
-        "@types/mocha": "^10.0.1",
-        "@types/path-browserify": "^1.0.0",
-        "@types/vscode": "^1.73.0",
-        "@types/webpack-env": "^1.18.1",
-        "@typescript-eslint/eslint-plugin": "^5.61.0",
-        "@typescript-eslint/parser": "^5.61.0",
-        "@vscode/test-web": "^0.0.44",
-        "@vue/compiler-sfc": "^3.3.4",
-        "assert": "^2.0.0",
-        "eslint": "^8.44.0",
+        "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+        "@types/mocha": "^10.0.6",
+        "@types/path-browserify": "^1.0.2",
+        "@types/vscode": "^1.84.2",
+        "@types/webpack-env": "^1.18.4",
+        "@typescript-eslint/eslint-plugin": "^6.12.0",
+        "@typescript-eslint/parser": "^6.12.0",
+        "@vscode/test-web": "^0.0.48",
+        "@vue/compiler-sfc": "^3.3.9",
+        "assert": "^2.1.0",
+        "eslint": "^8.54.0",
         "mocha": "^10.2.0",
-        "prettier": "^2.8.8",
+        "prettier": "^3.1.0",
         "process": "^0.11.10",
-        "ts-loader": "^9.4.4",
+        "ts-loader": "^9.5.1",
         "ts-node": "^10.9.1",
-        "typescript": "^5.1.6",
-        "webpack": "^5.88.1",
+        "typescript": "^5.3.2",
+        "webpack": "^5.89.0",
         "webpack-cli": "^5.1.4"
     },
     "dependencies": {
-        "edacation": "^0.2.1",
+        "edacation": "^0.2.3",
         "nextpnr": "^0.4.13",
         "path-browserify": "^1.0.1",
         "yosys": "^0.24.1"

src/common/universal-worker.ts

@@ -0,0 +1,92 @@
+import type {TransferListItem} from 'worker_threads';
+
+import type {ExtensionMessage, WorkerMessage} from './messages.js';
+
+/* eslint-disable @typescript-eslint/consistent-type-imports */
+type WorkerThreadsModule = typeof import('worker_threads');
+type WorkerThreadsWorker = import('worker_threads').Worker;
+/* eslint-enable @typescript-eslint/consistent-type-imports */
+
+const module: WorkerThreadsModule | undefined =
+    typeof Worker === 'undefined' ? __non_webpack_require__('worker_threads') : undefined;
+
+type InternalNodeWorker = {
+    type: 'node';
+    worker: WorkerThreadsWorker;
+};
+
+type InternalWebWorker = {
+    type: 'web';
+    worker: Worker;
+};
+
+type InternalWorker = InternalNodeWorker | InternalWebWorker;
+
+interface EventCallbacks {
+    error: (err: Error) => void;
+    messageerror: (err: Error) => void;
+    message: ((message: ExtensionMessage) => void) | ((message: WorkerMessage) => void);
+}
+
+export const sendMessage = (message: ExtensionMessage, transferables: readonly TransferListItem[] & Transferable[]) => {
+    if (module) {
+        module.parentPort?.postMessage(message, transferables);
+    } else {
+        postMessage(message, transferables);
+    }
+};
+
+export const onEvent = <E extends keyof EventCallbacks>(event: E, callback: EventCallbacks[E]): void => {
+    if (module) {
+        module.parentPort?.on(event, callback);
+    } else {
+        addEventListener(event, (event) => callback(extractData(event)));
+    }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const extractData = (event: MessageEvent | ErrorEvent): any => {
+    if (event instanceof MessageEvent) {
+        return event.data;
+    }
+    return event;
+};
+
+export class UniversalWorker {
+    private worker: InternalWorker;
+
+    constructor(url: string | URL, options?: WorkerOptions) {
+        if (typeof url === 'string') {
+            url = new URL(url);
+        }
+
+        if (module) {
+            console.log('Creating Node.js worker');
+            this.worker = {
+                type: 'node',
+                worker: new module.Worker(url, options)
+            };
+        } else {
+            console.log('Creating Web Worker');
+            this.worker = {
+                type: 'web',
+                worker: new Worker(url, options)
+            };
+        }
+    }
+
+    public onEvent<E extends keyof EventCallbacks>(event: E, callback: EventCallbacks[E]): void {
+        if (this.worker.type === 'web') {
+            this.worker.worker.addEventListener(event, (event) => callback(extractData(event)));
+        } else {
+            this.worker.worker.on(event, callback);
+        }
+    }
+
+    public sendMessage(
+        message: WorkerMessage,
+        transferList?: StructuredSerializeOptions & readonly TransferListItem[]
+    ) {
+        this.worker.worker.postMessage(message, transferList);
+    }
+}

src/extension/tasks/messaging.ts

@@ -0,0 +1,62 @@
+export enum AnsiModifier {
+    RESET = '\x1b[0m',
+    BOLD = '\x1b[1m',
+    RED = '\x1b[31m',
+    GREEN = '\x1b[32m'
+}
+
+export interface TaskOutputFile {
+    path: string;
+    data?: Uint8Array;
+}
+
+export interface TerminalMessagePrintln {
+    type: 'println';
+    stream: 'stdout' | 'stderr';
+    line?: string;
+    modifier?: AnsiModifier;
+}
+
+export interface TerminalMessageError {
+    type: 'error';
+    error: unknown;
+}
+
+export interface TerminalMessageDone {
+    type: 'done';
+    outputFiles?: TaskOutputFile[];
+}
+
+export type TerminalMessage = TerminalMessagePrintln | TerminalMessageError | TerminalMessageDone;
+
+type MessageCallback = (m: TerminalMessage) => void;
+
+export abstract class TerminalMessageEmitter {
+    private messageCallbacks: MessageCallback[];
+
+    constructor() {
+        this.messageCallbacks = [];
+    }
+
+    public onMessage(callback: MessageCallback) {
+        this.messageCallbacks.push(callback);
+    }
+
+    private fire(message: TerminalMessage) {
+        for (const callback of this.messageCallbacks) {
+            callback(message);
+        }
+    }
+
+    protected println(line = '', stream: 'stdout' | 'stderr' = 'stdout', modifier?: AnsiModifier) {
+        this.fire({type: 'println', stream, line, modifier});
+    }
+
+    protected error(error: unknown) {
+        this.fire({type: 'error', error});
+    }
+
+    protected done(outputFiles?: TaskOutputFile[]) {
+        this.fire({type: 'done', outputFiles});
+    }
+}