NOT READY! | Rust support

Signed-off-by: paulober <[email protected]>

Author: paulober

.vscodeignore

@@ -31,6 +31,7 @@ tmp.py
 !scripts/lwipopts.h
 !scripts/pico_configs.tsv
 !scripts/pico_project.py
+!scripts/portable-msvc.py
 !scripts/pico-vscode.cmake
 !scripts/Pico.code-profile
 !scripts/raspberrypi-swd.cfg

README.md

@@ -86,6 +86,12 @@ For optimal functionality, consider enabling:
 
 When prompted, select the `Pico` kit in CMake Tools, and set your build and launch targets accordingly. Use CMake Tools for compilation, but continue using this extension for debugging, as CMake Tools debugging is not compatible with Pico.
 
+## Rust Prerequisites
+
+### Linux
+
+- **GCC** for the host architecture
+
 ## VS Code Profiles
 
 If you work with multiple microcontroller toolchains, consider installing this extension into a [VS Code Profile](https://code.visualstudio.com/docs/editor/profiles) to avoid conflicts with other toolchains. Follow these steps:

package.json

@@ -65,6 +65,7 @@
   },
   "activationEvents": [
     "workspaceContains:./pico_sdk_import.cmake",
+    "workspaceContains:./.pico-rs",
     "onWebviewPanel:newPicoProject",
     "onWebviewPanel:newPicoMicroPythonProject"
   ],
@@ -79,13 +80,13 @@
         "command": "raspberry-pi-pico.switchSDK",
         "title": "Switch Pico SDK",
         "category": "Raspberry Pi Pico",
-        "enablement": "raspberry-pi-pico.isPicoProject"
+        "enablement": "raspberry-pi-pico.isPicoProject && !raspberry-pi-pico.isRustProject"
       },
       {
         "command": "raspberry-pi-pico.switchBoard",
         "title": "Switch Board",
         "category": "Raspberry Pi Pico",
-        "enablement": "raspberry-pi-pico.isPicoProject"
+        "enablement": "raspberry-pi-pico.isPicoProject && !raspberry-pi-pico.isRustProject"
       },
       {
         "command": "raspberry-pi-pico.launchTargetPath",
@@ -151,7 +152,7 @@
         "command": "raspberry-pi-pico.runProject",
         "title": "Run Pico Project (USB)",
         "category": "Raspberry Pi Pico",
-        "enablement": "raspberry-pi-pico.isPicoProject"
+        "enablement": "raspberry-pi-pico.isPicoProject && !raspberry-pi-pico.isRustProject"
       },
       {
         "command": "raspberry-pi-pico.clearGithubApiCache",
@@ -162,7 +163,7 @@
         "command": "raspberry-pi-pico.conditionalDebugging",
         "title": "Conditional Debugging",
         "category": "Raspberry Pi Pico",
-        "enablement": "raspberry-pi-pico.isPicoProject && !inQuickOpen"
+        "enablement": "raspberry-pi-pico.isPicoProject && !inQuickOpen && !raspberry-pi-pico.isRustProject"
       },
       {
         "command": "raspberry-pi-pico.debugLayout",
@@ -179,7 +180,7 @@
         "command": "raspberry-pi-pico.configureCmake",
         "title": "Configure CMake",
         "category": "Raspberry Pi Pico",
-        "enablement": "raspberry-pi-pico.isPicoProject"
+        "enablement": "raspberry-pi-pico.isPicoProject && !raspberry-pi-pico.isRustProject"
       },
       {
         "command": "raspberry-pi-pico.importProject",
@@ -200,7 +201,7 @@
         "command": "raspberry-pi-pico.flashProject",
         "title": "Flash Pico Project (SWD)",
         "category": "Raspberry Pi Pico",
-        "enablement": "raspberry-pi-pico.isPicoProject"
+        "enablement": "raspberry-pi-pico.isPicoProject && !raspberry-pi-pico.isRustProject"
       }
     ],
     "configuration": {
@@ -307,6 +308,7 @@
     "got": "^14.4.2",
     "ini": "^4.1.3",
     "rimraf": "^5.0.7",
+    "toml": "^3.0.0",
     "undici": "^6.19.7",
     "uuid": "^10.0.0",
     "which": "^4.0.0"

src/commands/compileProject.mts

@@ -3,6 +3,8 @@ import { EventEmitter } from "events";
 import { CommandWithResult } from "./command.mjs";
 import Logger from "../logger.mjs";
 import Settings, { SettingsKey } from "../settings.mjs";
+import { ContextKeys } from "../contextKeys.mjs";
+import State from "../state.mjs";
 
 export default class CompileProjectCommand extends CommandWithResult<boolean> {
   private _logger: Logger = new Logger("CompileProjectCommand");
@@ -18,9 +20,15 @@ export default class CompileProjectCommand extends CommandWithResult<boolean> {
     const task = (await tasks.fetchTasks()).find(
       task => task.name === "Compile Project"
     );
+    /*const isRustProject = await commands.executeCommand(
+      "getContext",
+      ContextKeys.isRustProject
+    );*/
+    const isRustProject = State.getInstance().isRustProject;
 
     const settings = Settings.getInstance();
     if (
+      !isRustProject &&
       settings !== undefined &&
       settings.getBoolean(SettingsKey.useCmakeTools)
     ) {

src/commands/newProject.mts

@@ -4,6 +4,7 @@ import { window, type Uri } from "vscode";
 import { NewProjectPanel } from "../webview/newProjectPanel.mjs";
 // eslint-disable-next-line max-len
 import { NewMicroPythonProjectPanel } from "../webview/newMicroPythonProjectPanel.mjs";
+import { NewRustProjectPanel } from "../webview/newRustProjectPanel.mjs";
 
 /**
  * Enum for the language of the project.
@@ -13,13 +14,15 @@ import { NewMicroPythonProjectPanel } from "../webview/newMicroPythonProjectPane
 export enum ProjectLang {
   cCpp = 1,
   micropython = 2,
+  rust = 3,
 }
 
 export default class NewProjectCommand extends CommandWithArgs {
   private readonly _logger: Logger = new Logger("NewProjectCommand");
   private readonly _extensionUri: Uri;
   private static readonly micropythonOption = "MicroPython";
   private static readonly cCppOption = "C/C++";
+  private static readonly rustOption = "Rust (experimental)";
 
   public static readonly id = "newProject";
 
@@ -34,6 +37,8 @@ export default class NewProjectCommand extends CommandWithArgs {
       ? NewProjectCommand.cCppOption
       : preSelectedType === ProjectLang.micropython
       ? NewProjectCommand.micropythonOption
+      : preSelectedType === ProjectLang.rust
+      ? NewProjectCommand.rustOption
       : undefined;
   }
 
@@ -42,7 +47,11 @@ export default class NewProjectCommand extends CommandWithArgs {
     const lang =
       this.preSelectedTypeToStr(preSelectedType) ??
       (await window.showQuickPick(
-        [NewProjectCommand.cCppOption, NewProjectCommand.micropythonOption],
+        [
+          NewProjectCommand.cCppOption,
+          NewProjectCommand.micropythonOption,
+          NewProjectCommand.rustOption,
+        ],
         {
           placeHolder: "Select which language to use for your new project",
           canPickMany: false,
@@ -58,6 +67,9 @@ export default class NewProjectCommand extends CommandWithArgs {
     if (lang === NewProjectCommand.micropythonOption) {
       // create a new project with MicroPython
       NewMicroPythonProjectPanel.createOrShow(this._extensionUri);
+    } else if (lang === NewProjectCommand.rustOption) {
+      // create a new project with Rust
+      NewRustProjectPanel.createOrShow(this._extensionUri);
     } else {
       // show webview where the process of creating a new project is continued
       NewProjectPanel.createOrShow(this._extensionUri);

src/contextKeys.mts

@@ -2,4 +2,5 @@ import { extensionName } from "./commands/command.mjs";
 
 export enum ContextKeys {
   isPicoProject = `${extensionName}.isPicoProject`,
+  isRustProject = `${extensionName}.isRustProject`,
 }

src/extension.mts

@@ -76,6 +76,8 @@ import FlashProjectSWDCommand from "./commands/flashProjectSwd.mjs";
 import { NewMicroPythonProjectPanel } from "./webview/newMicroPythonProjectPanel.mjs";
 import type { Progress as GotProgress } from "got";
 import findPython, { showPythonNotFoundError } from "./utils/pythonHelper.mjs";
+import { downloadAndInstallRust } from "./utils/rustUtil.mjs";
+import State from "./state.mjs";
 
 export async function activate(context: ExtensionContext): Promise<void> {
   Logger.info(LoggerSource.extension, "Extension activation triggered");
@@ -166,11 +168,15 @@ export async function activate(context: ExtensionContext): Promise<void> {
   );
 
   const workspaceFolder = workspace.workspaceFolders?.[0];
+  const isRustProject = workspaceFolder
+    ? existsSync(join(workspaceFolder.uri.fsPath, ".pico-rs"))
+    : false;
 
   // check if is a pico project
   if (
     workspaceFolder === undefined ||
-    !existsSync(join(workspaceFolder.uri.fsPath, "pico_sdk_import.cmake"))
+    (!existsSync(join(workspaceFolder.uri.fsPath, "pico_sdk_import.cmake")) &&
+      !isRustProject)
   ) {
     // finish activation
     Logger.warn(
@@ -186,55 +192,87 @@ export async function activate(context: ExtensionContext): Promise<void> {
     return;
   }
 
-  const cmakeListsFilePath = join(workspaceFolder.uri.fsPath, "CMakeLists.txt");
-  if (!existsSync(cmakeListsFilePath)) {
-    Logger.warn(
-      LoggerSource.extension,
-      "No CMakeLists.txt in workspace folder has been found."
-    );
-    await commands.executeCommand(
-      "setContext",
-      ContextKeys.isPicoProject,
-      false
+  /*void commands.executeCommand(
+    "setContext",
+    ContextKeys.isRustProject,
+    isRustProject
+  );*/
+  State.getInstance().isRustProject = isRustProject;
+
+  if (!isRustProject) {
+    const cmakeListsFilePath = join(
+      workspaceFolder.uri.fsPath,
+      "CMakeLists.txt"
     );
+    if (!existsSync(cmakeListsFilePath)) {
+      Logger.warn(
+        LoggerSource.extension,
+        "No CMakeLists.txt in workspace folder has been found."
+      );
+      await commands.executeCommand(
+        "setContext",
+        ContextKeys.isPicoProject,
+        false
+      );
 
-    return;
+      return;
+    }
+
+    // check if it has .vscode folder and cmake donotedit header in CMakelists.txt
+    if (
+      !existsSync(join(workspaceFolder.uri.fsPath, ".vscode")) ||
+      !readFileSync(cmakeListsFilePath)
+        .toString("utf-8")
+        .includes(CMAKE_DO_NOT_EDIT_HEADER_PREFIX)
+    ) {
+      Logger.warn(
+        LoggerSource.extension,
+        "No .vscode folder and/or cmake",
+        '"DO NOT EDIT"-header in CMakelists.txt found.'
+      );
+      await commands.executeCommand(
+        "setContext",
+        ContextKeys.isPicoProject,
+        false
+      );
+      const wantToImport = await window.showInformationMessage(
+        "Do you want to import this project as Raspberry Pi Pico project?",
+        "Yes",
+        "No"
+      );
+      if (wantToImport === "Yes") {
+        void commands.executeCommand(
+          `${extensionName}.${ImportProjectCommand.id}`,
+          workspaceFolder.uri
+        );
+      }
+
+      return;
+    }
   }
 
-  // check if it has .vscode folder and cmake donotedit header in CMakelists.txt
-  if (
-    !existsSync(join(workspaceFolder.uri.fsPath, ".vscode")) ||
-    !readFileSync(cmakeListsFilePath)
-      .toString("utf-8")
-      .includes(CMAKE_DO_NOT_EDIT_HEADER_PREFIX)
-  ) {
-    Logger.warn(
-      LoggerSource.extension,
-      "No .vscode folder and/or cmake",
-      '"DO NOT EDIT"-header in CMakelists.txt found.'
-    );
-    await commands.executeCommand(
-      "setContext",
-      ContextKeys.isPicoProject,
-      false
-    );
-    const wantToImport = await window.showInformationMessage(
-      "Do you want to import this project as Raspberry Pi Pico project?",
-      "Yes",
-      "No"
+  await commands.executeCommand("setContext", ContextKeys.isPicoProject, true);
+
+  if (isRustProject) {
+    const cargo = await window.withProgress(
+      {
+        location: ProgressLocation.Notification,
+        title: "Downloading and installing Rust. This may take a while...",
+        cancellable: false,
+      },
+      async () => downloadAndInstallRust()
     );
-    if (wantToImport === "Yes") {
-      void commands.executeCommand(
-        `${extensionName}.${ImportProjectCommand.id}`,
-        workspaceFolder.uri
-      );
+    if (!cargo) {
+      void window.showErrorMessage("Failed to install Rust.");
+
+      return;
     }
 
+    ui.showStatusBarItems(isRustProject);
+
     return;
   }
 
-  await commands.executeCommand("setContext", ContextKeys.isPicoProject, true);
-
   // get sdk selected in the project
   const selectedToolchainAndSDKVersions =
     await cmakeGetSelectedToolchainAndSDKVersions(workspaceFolder.uri);

src/logger.mts

@@ -40,6 +40,7 @@ export enum LoggerSource {
   cmake = "cmakeUtil",
   downloadHelper = "downloadHelper",
   pythonHelper = "pythonHelper",
+  rustUtil = "rustUtil",
 }
 
 /**

src/state.mts

@@ -0,0 +1,14 @@
+export default class State {
+  private static instance?: State;
+  public isRustProject = false;
+
+  public constructor() {}
+
+  public static getInstance(): State {
+    if (!State.instance) {
+      this.instance = new State();
+    }
+
+    return this.instance!;
+  }
+}