mirror of
https://github.com/rust-lang/rust-analyzer
synced 2024-12-26 13:03:31 +00:00
"rust-analyzer.debug" command
This commit is contained in:
parent
eb892d707c
commit
155f060142
4 changed files with 145 additions and 107 deletions
|
@ -120,6 +120,11 @@
|
||||||
"title": "Run",
|
"title": "Run",
|
||||||
"category": "Rust Analyzer"
|
"category": "Rust Analyzer"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"command": "rust-analyzer.debug",
|
||||||
|
"title": "Debug",
|
||||||
|
"category": "Rust Analyzer"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"command": "rust-analyzer.analyzerStatus",
|
"command": "rust-analyzer.analyzerStatus",
|
||||||
"title": "Status",
|
"title": "Status",
|
||||||
|
|
|
@ -1,43 +1,46 @@
|
||||||
import * as vscode from 'vscode';
|
import * as vscode from 'vscode';
|
||||||
import * as lc from 'vscode-languageclient';
|
import * as lc from 'vscode-languageclient';
|
||||||
import * as ra from '../rust-analyzer-api';
|
import * as ra from '../rust-analyzer-api';
|
||||||
import * as os from "os";
|
|
||||||
|
|
||||||
import { Ctx, Cmd } from '../ctx';
|
import { Ctx, Cmd } from '../ctx';
|
||||||
import { Cargo } from '../cargo';
|
import { startDebugSession } from '../debug';
|
||||||
|
|
||||||
|
async function selectRunnable(ctx: Ctx, prevRunnable: RunnableQuickPick | undefined): Promise<RunnableQuickPick | undefined> {
|
||||||
|
const editor = ctx.activeRustEditor;
|
||||||
|
const client = ctx.client;
|
||||||
|
if (!editor || !client) return;
|
||||||
|
|
||||||
|
const textDocument: lc.TextDocumentIdentifier = {
|
||||||
|
uri: editor.document.uri.toString(),
|
||||||
|
};
|
||||||
|
|
||||||
|
const runnables = await client.sendRequest(ra.runnables, {
|
||||||
|
textDocument,
|
||||||
|
position: client.code2ProtocolConverter.asPosition(
|
||||||
|
editor.selection.active,
|
||||||
|
),
|
||||||
|
});
|
||||||
|
const items: RunnableQuickPick[] = [];
|
||||||
|
if (prevRunnable) {
|
||||||
|
items.push(prevRunnable);
|
||||||
|
}
|
||||||
|
for (const r of runnables) {
|
||||||
|
if (
|
||||||
|
prevRunnable &&
|
||||||
|
JSON.stringify(prevRunnable.runnable) === JSON.stringify(r)
|
||||||
|
) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
items.push(new RunnableQuickPick(r));
|
||||||
|
}
|
||||||
|
return await vscode.window.showQuickPick(items);
|
||||||
|
}
|
||||||
|
|
||||||
export function run(ctx: Ctx): Cmd {
|
export function run(ctx: Ctx): Cmd {
|
||||||
let prevRunnable: RunnableQuickPick | undefined;
|
let prevRunnable: RunnableQuickPick | undefined;
|
||||||
|
|
||||||
return async () => {
|
return async () => {
|
||||||
const editor = ctx.activeRustEditor;
|
const item = await selectRunnable(ctx, prevRunnable);
|
||||||
const client = ctx.client;
|
|
||||||
if (!editor || !client) return;
|
|
||||||
|
|
||||||
const textDocument: lc.TextDocumentIdentifier = {
|
|
||||||
uri: editor.document.uri.toString(),
|
|
||||||
};
|
|
||||||
|
|
||||||
const runnables = await client.sendRequest(ra.runnables, {
|
|
||||||
textDocument,
|
|
||||||
position: client.code2ProtocolConverter.asPosition(
|
|
||||||
editor.selection.active,
|
|
||||||
),
|
|
||||||
});
|
|
||||||
const items: RunnableQuickPick[] = [];
|
|
||||||
if (prevRunnable) {
|
|
||||||
items.push(prevRunnable);
|
|
||||||
}
|
|
||||||
for (const r of runnables) {
|
|
||||||
if (
|
|
||||||
prevRunnable &&
|
|
||||||
JSON.stringify(prevRunnable.runnable) === JSON.stringify(r)
|
|
||||||
) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
items.push(new RunnableQuickPick(r));
|
|
||||||
}
|
|
||||||
const item = await vscode.window.showQuickPick(items);
|
|
||||||
if (!item) return;
|
if (!item) return;
|
||||||
|
|
||||||
item.detail = 'rerun';
|
item.detail = 'rerun';
|
||||||
|
@ -64,88 +67,22 @@ export function runSingle(ctx: Ctx): Cmd {
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function getLldbDebugConfig(config: ra.Runnable, executable: string, sourceFileMap?: Record<string, string>): vscode.DebugConfiguration {
|
export function debug(ctx: Ctx): Cmd {
|
||||||
return {
|
let prevDebuggee: RunnableQuickPick | undefined;
|
||||||
type: "lldb",
|
|
||||||
request: "launch",
|
return async () => {
|
||||||
name: config.label,
|
const item = await selectRunnable(ctx, prevDebuggee);
|
||||||
program: executable,
|
if (!item) return;
|
||||||
args: config.extraArgs,
|
|
||||||
cwd: config.cwd,
|
item.detail = 'restart';
|
||||||
sourceMap: sourceFileMap,
|
prevDebuggee = item;
|
||||||
sourceLanguages: ["rust"]
|
return await startDebugSession(ctx, item.runnable);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function getCppvsDebugConfig(config: ra.Runnable, executable: string, sourceFileMap?: Record<string, string>): vscode.DebugConfiguration {
|
|
||||||
return {
|
|
||||||
type: (os.platform() === "win32") ? "cppvsdbg" : 'cppdbg',
|
|
||||||
request: "launch",
|
|
||||||
name: config.label,
|
|
||||||
program: executable,
|
|
||||||
args: config.extraArgs,
|
|
||||||
cwd: config.cwd,
|
|
||||||
sourceFileMap: sourceFileMap,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const debugOutput = vscode.window.createOutputChannel("Debug");
|
|
||||||
|
|
||||||
async function getDebugExecutable(config: ra.Runnable): Promise<string> {
|
|
||||||
const cargo = new Cargo(config.cwd || '.', debugOutput);
|
|
||||||
const executable = await cargo.executableFromArgs(config.args);
|
|
||||||
|
|
||||||
// if we are here, there were no compilation errors.
|
|
||||||
return executable;
|
|
||||||
}
|
|
||||||
|
|
||||||
type DebugConfigProvider = (config: ra.Runnable, executable: string, sourceFileMap?: Record<string, string>) => vscode.DebugConfiguration;
|
|
||||||
|
|
||||||
export function debugSingle(ctx: Ctx): Cmd {
|
export function debugSingle(ctx: Ctx): Cmd {
|
||||||
return async (config: ra.Runnable) => {
|
return async (config: ra.Runnable) => {
|
||||||
const editor = ctx.activeRustEditor;
|
await startDebugSession(ctx, config);
|
||||||
if (!editor) return;
|
|
||||||
|
|
||||||
const knownEngines: Record<string, DebugConfigProvider> = {
|
|
||||||
"vadimcn.vscode-lldb": getLldbDebugConfig,
|
|
||||||
"ms-vscode.cpptools": getCppvsDebugConfig
|
|
||||||
};
|
|
||||||
const debugOptions = ctx.config.debug;
|
|
||||||
|
|
||||||
let debugEngine = null;
|
|
||||||
if (debugOptions.engine === "auto") {
|
|
||||||
for (var engineId in knownEngines) {
|
|
||||||
debugEngine = vscode.extensions.getExtension(engineId);
|
|
||||||
if (debugEngine) break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
debugEngine = vscode.extensions.getExtension(debugOptions.engine);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!debugEngine) {
|
|
||||||
vscode.window.showErrorMessage(`Install [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)`
|
|
||||||
+ ` or [MS C++ tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) extension for debugging.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
debugOutput.clear();
|
|
||||||
if (ctx.config.debug.openUpDebugPane) {
|
|
||||||
debugOutput.show(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
const executable = await getDebugExecutable(config);
|
|
||||||
const debugConfig = knownEngines[debugEngine.id](config, executable, debugOptions.sourceFileMap);
|
|
||||||
if (debugConfig.type in debugOptions.engineSettings) {
|
|
||||||
const settingsMap = (debugOptions.engineSettings as any)[debugConfig.type];
|
|
||||||
for (var key in settingsMap) {
|
|
||||||
debugConfig[key] = settingsMap[key];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
debugOutput.appendLine("Launching debug configuration:");
|
|
||||||
debugOutput.appendLine(JSON.stringify(debugConfig, null, 2));
|
|
||||||
return vscode.debug.startDebugging(undefined, debugConfig);
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
95
editors/code/src/debug.ts
Normal file
95
editors/code/src/debug.ts
Normal file
|
@ -0,0 +1,95 @@
|
||||||
|
import * as os from "os";
|
||||||
|
import * as vscode from 'vscode';
|
||||||
|
import * as ra from './rust-analyzer-api';
|
||||||
|
|
||||||
|
import { Cargo } from './cargo';
|
||||||
|
import { Ctx } from "./ctx";
|
||||||
|
|
||||||
|
const debugOutput = vscode.window.createOutputChannel("Debug");
|
||||||
|
type DebugConfigProvider = (config: ra.Runnable, executable: string, sourceFileMap?: Record<string, string>) => vscode.DebugConfiguration;
|
||||||
|
|
||||||
|
function getLldbDebugConfig(config: ra.Runnable, executable: string, sourceFileMap?: Record<string, string>): vscode.DebugConfiguration {
|
||||||
|
return {
|
||||||
|
type: "lldb",
|
||||||
|
request: "launch",
|
||||||
|
name: config.label,
|
||||||
|
program: executable,
|
||||||
|
args: config.extraArgs,
|
||||||
|
cwd: config.cwd,
|
||||||
|
sourceMap: sourceFileMap,
|
||||||
|
sourceLanguages: ["rust"]
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function getCppvsDebugConfig(config: ra.Runnable, executable: string, sourceFileMap?: Record<string, string>): vscode.DebugConfiguration {
|
||||||
|
return {
|
||||||
|
type: (os.platform() === "win32") ? "cppvsdbg" : "cppdbg",
|
||||||
|
request: "launch",
|
||||||
|
name: config.label,
|
||||||
|
program: executable,
|
||||||
|
args: config.extraArgs,
|
||||||
|
cwd: config.cwd,
|
||||||
|
sourceFileMap: sourceFileMap,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function getDebugExecutable(config: ra.Runnable): Promise<string> {
|
||||||
|
const cargo = new Cargo(config.cwd || '.', debugOutput);
|
||||||
|
const executable = await cargo.executableFromArgs(config.args);
|
||||||
|
|
||||||
|
// if we are here, there were no compilation errors.
|
||||||
|
return executable;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getDebugConfiguration(ctx: Ctx, config: ra.Runnable): Promise<vscode.DebugConfiguration | undefined> {
|
||||||
|
const editor = ctx.activeRustEditor;
|
||||||
|
if (!editor) return;
|
||||||
|
|
||||||
|
const knownEngines: Record<string, DebugConfigProvider> = {
|
||||||
|
"vadimcn.vscode-lldb": getLldbDebugConfig,
|
||||||
|
"ms-vscode.cpptools": getCppvsDebugConfig
|
||||||
|
};
|
||||||
|
const debugOptions = ctx.config.debug;
|
||||||
|
|
||||||
|
let debugEngine = null;
|
||||||
|
if (debugOptions.engine === "auto") {
|
||||||
|
for (var engineId in knownEngines) {
|
||||||
|
debugEngine = vscode.extensions.getExtension(engineId);
|
||||||
|
if (debugEngine) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
debugEngine = vscode.extensions.getExtension(debugOptions.engine);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!debugEngine) {
|
||||||
|
vscode.window.showErrorMessage(`Install [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)`
|
||||||
|
+ ` or [MS C++ tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) extension for debugging.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
debugOutput.clear();
|
||||||
|
if (ctx.config.debug.openUpDebugPane) {
|
||||||
|
debugOutput.show(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
const executable = await getDebugExecutable(config);
|
||||||
|
const debugConfig = knownEngines[debugEngine.id](config, executable, debugOptions.sourceFileMap);
|
||||||
|
if (debugConfig.type in debugOptions.engineSettings) {
|
||||||
|
const settingsMap = (debugOptions.engineSettings as any)[debugConfig.type];
|
||||||
|
for (var key in settingsMap) {
|
||||||
|
debugConfig[key] = settingsMap[key];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return debugConfig;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function startDebugSession(ctx: Ctx, config: ra.Runnable): Promise<boolean> {
|
||||||
|
const debugConfig = await getDebugConfiguration(ctx, config);
|
||||||
|
if (!debugConfig) return false;
|
||||||
|
|
||||||
|
debugOutput.appendLine("Launching debug configuration:");
|
||||||
|
debugOutput.appendLine(JSON.stringify(debugConfig, null, 2));
|
||||||
|
return vscode.debug.startDebugging(undefined, debugConfig);
|
||||||
|
}
|
|
@ -77,6 +77,7 @@ export async function activate(context: vscode.ExtensionContext) {
|
||||||
ctx.registerCommand('syntaxTree', commands.syntaxTree);
|
ctx.registerCommand('syntaxTree', commands.syntaxTree);
|
||||||
ctx.registerCommand('expandMacro', commands.expandMacro);
|
ctx.registerCommand('expandMacro', commands.expandMacro);
|
||||||
ctx.registerCommand('run', commands.run);
|
ctx.registerCommand('run', commands.run);
|
||||||
|
ctx.registerCommand('debug', commands.debug);
|
||||||
|
|
||||||
defaultOnEnter.dispose();
|
defaultOnEnter.dispose();
|
||||||
ctx.registerCommand('onEnter', commands.onEnter);
|
ctx.registerCommand('onEnter', commands.onEnter);
|
||||||
|
|
Loading…
Reference in a new issue