Internally VS Code uses debug uris to refer to DAP provided sources. Debug uris have this format:

/**
 * Debug URI format
 *
 * a debug URI represents a Source object and the debug session where the Source comes from.
 *
 *       debug:arbitrary_path?session=123e4567-e89b-12d3-a456-426655440000&ref=1016
 *       \___/ \____________/ \__________________________________________/ \______/
 *         |          |                             |                          |
 *      scheme   source.path                    session id            source.reference
 */

Today's problem:

By using VS Code's internal knowledge about debug Uris, it is possible to construct a debug uri based on a DAP Source object. Please note that the "Source" structure is a DAP concept that is not surfaced in VS Code's debug API.

 export function openScript(session: vscode.DebugSession | undefined, source: Source) {
	let uri: vscode.Uri;
	if (source.sourceReference) {
		let debug = `debug:${encodeURIComponent(source.path)}`;
		let sep = '?';
		if (session) {
			debug += `${sep}session=${encodeURIComponent(session.id)}`;
			sep = '&';
		}
		debug += `${sep}ref=${source.sourceReference}`;
		uri = vscode.Uri.parse(debug);
	} else {
		uri = vscode.Uri.file(source.path);
	}
	vscode.workspace.openTextDocument(uri).then(doc => vscode.window.showTextDocument(doc));
}

New API proposal:

export function openScript(session: vscode.DebugSession | undefined, source: Source) {
	const uri = session.createDebugUri(src);
	vscode.workspace.openTextDocument(uri).then(doc => vscode.window.showTextDocument(doc));
}

Alternative:

export function openScript(session: vscode.DebugSession | undefined, source: Source) {
	session.showSource(source);
}

Open issue:

"Source" is a DAP construct which is not available in VS Code's debug API.

Consider to surface debug URIs in the API #79228

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions