Q#

// Copyright (c) Microsoft Corporation. // Licensed under the MIT License. import * as vscode from "vscode"; import { runProgramInTerminal } from "./run"; export class CircuitEditorProvider implements vscode.CustomTextEditorProvider { private static readonly viewType = "qsharp-webview.circuit"; updatingDocument: boolean = false; public static register(context: vscode.ExtensionContext): vscode.Disposable { const provider = new CircuitEditorProvider(context); const providerRegistration = vscode.window.registerCustomEditorProvider( CircuitEditorProvider.viewType, provider, { webviewOptions: { retainContextWhenHidden: true } }, ); return providerRegistration; } constructor(private readonly context: vscode.ExtensionContext) {} public async resolveCustomTextEditor( document: vscode.TextDocument, webviewPanel: vscode.WebviewPanel, ): Promise { // Setup initial content for the webview webviewPanel.webview.options = { enableScripts: true, }; webviewPanel.webview.html = this.getHtmlForWebview(webviewPanel.webview); webviewPanel.webview.onDidReceiveMessage(async (e) => { switch (e.command) { case "update": this.updateTextDocument(document, e.text); return; case "read": updateWebview(); return; case "run": { const entry = await generateQubitCircuitExpression(document.uri); runProgramInTerminal( this.context.extensionUri, document.uri, "QDK: Run Circuit File", entry, ); return; } } }); const updateWebview = () => { const result = this.getDocumentAsJson(document); const filename = document.fileName.split(/\\|\//).pop()!.split(".")[0]; if (result.error) { const message = { command: "error", props: { title: `${filename}`, message: result.error, }, }; webviewPanel.webview.postMessage(message); return; } const circuit = result.data; const props = { title: `${filename}`, targetProfile: "", simulated: false, calculating: false, circuit, }; const message = { command: "circuit", props, }; webviewPanel.webview.postMessage(message); }; // Update the webview when the text document changes const changeDocumentSubscription = vscode.workspace.onDidChangeTextDocument( (event) => { if (event.document.uri.toString() === document.uri.toString()) { if (!this.updatingDocument && event.contentChanges.length > 0) { // Update the webview with the new document content updateWebview(); } } }, ); // Dispose of the event listener when the webview is closed webviewPanel.onDidDispose(() => { changeDocumentSubscription.dispose(); }); } private getHtmlForWebview(webview: vscode.Webview): string { const extensionUri = this.context.extensionUri; function getUri(pathList: string[]) { return webview.asWebviewUri( vscode.Uri.joinPath(extensionUri, ...pathList), ); } const katexCss = getUri(["out", "katex", "katex.min.css"]); const githubCss = getUri(["out", "katex", "github-markdown-dark.css"]); const webviewCss = getUri(["out", "webview", "webview.css"]); const scriptUri = getUri(["out", "webview", "editor.js"]); const resourcesUri = getUri(["resources"]); return ` Q# `; } private getDocumentAsJson(document: vscode.TextDocument): { error?: string; data?: any; } { const text = document.getText(); if (text.trim().length === 0) { return { data: {} }; } try { return { data: JSON.parse(text) }; } catch { return { error: "Content is not valid JSON" }; } } private async updateTextDocument( document: vscode.TextDocument, circuit: string, ) { // Short-circuit if there are no changes to be made. if ( circuit.trim().replace(/\r\n/g, "\n") === document.getText().trim().replace(/\r\n/g, "\n") ) { return; } const edit = new vscode.WorkspaceEdit(); edit.replace( document.uri, new vscode.Range(0, 0, document.lineCount, 0), circuit.trim(), ); this.updatingDocument = true; await vscode.workspace.applyEdit(edit); this.updatingDocument = false; } } /** * Generates a Q# entry expression for simulating a circuit operation defined in a JSON circuit file. * The entry expression will use the number of qubits specified in the JSON file and * call the operation with these qubits. It will then dump the machine state, reset the qubits, * and return the results (if any) of running the circuit. * * If any error occurs (invalid structure, missing fields, etc.), this function throws an error. * * @param resource The URI of the circuit JSON file. * @returns A Q# code block as a string. * @throws Error if the circuit file is invalid or required fields are missing. */ export async function generateQubitCircuitExpression( resource: vscode.Uri, ): Promise { let numQubits: number | undefined; try { const document = await vscode.workspace.openTextDocument(resource); const text = document.getText(); const json = JSON.parse(text); if ( !Array.isArray(json.circuits) || json.circuits.length === 0 || !Array.isArray(json.circuits[0].qubits) ) { throw new Error("Circuit file does not have expected structure."); } numQubits = json.circuits[0].qubits.length; if (typeof numQubits !== "number" || numQubits < 0) { throw new Error("Could not determine number of qubits."); } else if (numQubits === 0) { return `Message("Circuit is empty. Please add operations to the circuit.")`; } // Get operation name (file name without extension) const fileName = resource.path.substring( resource.path.lastIndexOf("/") + 1, ); const operationName = fileName.replace(/\.[^/.]+$/, ""); if (!operationName) { throw new Error("Could not determine operation name from file name."); } const namespaceName = operationName; const expr = `{ import Std.Diagnostics.DumpMachine; import ${namespaceName}.${operationName}; use qs = Qubit[${numQubits}]; let results = ${operationName}(qs); DumpMachine(); ResetAll(qs); results }`; return expr; } catch (err: any) { throw new Error( `Failed to generate Q# circuit expression: ${err?.message ?? err}`, { cause: err }, ); } }