add API to access DAP breakpoints; see microsoft#99716

weinand · weinand · commit c233bf87bcf1 · 2020-08-17T12:30:02.000+02:00
diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts
@@ -752,6 +752,17 @@ declare module 'vscode' {
 		compact?: boolean;
 	}
 
+	/**
+	 * A DebugProtocolBreakpoint is an opaque stand-in type for the [Breakpoint](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Breakpoint) type defined in the Debug Adapter Protocol.
+	 */
+	export interface DebugProtocolBreakpoint {
+		// Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Breakpoint).
+	}
+
+	export interface DebugSession {
+		getDebugProtocolBreakpoint(breakpoint: Breakpoint): DebugProtocolBreakpoint | undefined;
+	}
+
 	// deprecated debug API
 
 	export interface DebugConfigurationProvider {
diff --git a/src/vs/workbench/api/browser/mainThreadDebugService.ts b/src/vs/workbench/api/browser/mainThreadDebugService.ts
@@ -264,6 +264,14 @@ export class MainThreadDebugService implements MainThreadDebugServiceShape, IDeb
 		return Promise.reject(new Error('debug session not found'));
 	}
 
+	public $getDebugProtocolBreakpoint(sessionId: DebugSessionUUID, breakpoinId: string): Promise<DebugProtocol.Breakpoint | undefined> {
+		const session = this.debugService.getModel().getSession(sessionId, true);
+		if (session) {
+			return Promise.resolve(session.getDebugProtocolBreakpoint(breakpoinId));
+		}
+		return Promise.reject(new Error('debug session not found'));
+	}
+
 	public $stopDebugging(sessionId: DebugSessionUUID | undefined): Promise<void> {
 		if (sessionId) {
 			const session = this.debugService.getModel().getSession(sessionId, true);
diff --git a/src/vs/workbench/api/common/extHost.protocol.ts b/src/vs/workbench/api/common/extHost.protocol.ts
@@ -879,6 +879,7 @@ export interface MainThreadDebugServiceShape extends IDisposable {
 	$stopDebugging(sessionId: DebugSessionUUID | undefined): Promise<void>;
 	$setDebugSessionName(id: DebugSessionUUID, name: string): void;
 	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): Promise<any>;
+	$getDebugProtocolBreakpoint(id: DebugSessionUUID, breakpoinId: string): Promise<DebugProtocol.Breakpoint | undefined>;
 	$appendDebugConsole(value: string): void;
 	$startBreakpointEvents(): void;
 	$registerBreakpoints(breakpoints: Array<ISourceMultiBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>): Promise<void>;
diff --git a/src/vs/workbench/api/common/extHostDebugService.ts b/src/vs/workbench/api/common/extHostDebugService.ts
@@ -957,6 +957,10 @@ export class ExtHostDebugSession implements vscode.DebugSession {
 	public customRequest(command: string, args: any): Promise<any> {
 		return this._debugServiceProxy.$customDebugAdapterRequest(this._id, command, args);
 	}
+
+	public getDebugProtocolBreakpoint(breakpoint: vscode.Breakpoint): vscode.DebugProtocolBreakpoint | undefined {
+		return this._debugServiceProxy.$getDebugProtocolBreakpoint(this._id, breakpoint.id);
+	}
 }
 
 export class ExtHostDebugConsole implements vscode.DebugConsole {
diff --git a/src/vs/workbench/contrib/debug/browser/debugSession.ts b/src/vs/workbench/contrib/debug/browser/debugSession.ts
@@ -440,6 +440,10 @@ export class DebugSession implements IDebugSession {
 		return distinct(positions, p => `${p.lineNumber}:${p.column}`);
 	}
 
+	getDebugProtocolBreakpoint(breakpointId: string): DebugProtocol.Breakpoint | undefined {
+		return this.model.getDebugProtocolBreakpoint(breakpointId, this.getId());
+	}
+
 	customRequest(request: string, args: any): Promise<DebugProtocol.Response> {
 		if (!this.raw) {
 			throw new Error(localize('noDebugAdapter', "No debug adapter, can not send '{0}'", request));
diff --git a/src/vs/workbench/contrib/debug/common/debug.ts b/src/vs/workbench/contrib/debug/common/debug.ts
@@ -224,6 +224,7 @@ export interface IDebugSession extends ITreeElement {
 	sendDataBreakpoints(dbps: IDataBreakpoint[]): Promise<void>;
 	sendExceptionBreakpoints(exbpts: IExceptionBreakpoint[]): Promise<void>;
 	breakpointsLocations(uri: uri, lineNumber: number): Promise<IPosition[]>;
+	getDebugProtocolBreakpoint(breakpointId: string): DebugProtocol.Breakpoint | undefined;
 
 	stackTrace(threadId: number, startFrame: number, levels: number, token: CancellationToken): Promise<DebugProtocol.StackTraceResponse>;
 	exceptionInfo(threadId: number): Promise<IExceptionInfo | undefined>;
diff --git a/src/vs/workbench/contrib/debug/common/debugModel.ts b/src/vs/workbench/contrib/debug/common/debugModel.ts
@@ -597,6 +597,27 @@ export abstract class BaseBreakpoint extends Enablement implements IBaseBreakpoi
 		return data ? data.id : undefined;
 	}
 
+	getDebugProtocolBreakpoint(sessionId: string): DebugProtocol.Breakpoint | undefined {
+		const data = this.sessionData.get(sessionId);
+		if (data) {
+			const bp: DebugProtocol.Breakpoint = {
+				id: data.id,
+				verified: data.verified,
+				message: data.message,
+				source: data.source,
+				line: data.line,
+				column: data.column,
+				endLine: data.endLine,
+				endColumn: data.endColumn,
+				instructionReference: data.instructionReference,
+				offset: data.offset
+				// TODO: copy additional debug adapter data
+			};
+			return bp;
+		}
+		return undefined;
+	}
+
 	toJSON(): any {
 		const result = Object.create(null);
 		result.enabled = this.enabled;
@@ -1094,6 +1115,14 @@ export class DebugModel implements IDebugModel {
 		});
 	}
 
+	getDebugProtocolBreakpoint(breakpointId: string, sessionId: string): DebugProtocol.Breakpoint | undefined {
+		const bp = this.breakpoints.find(bp => bp.getId());
+		if (bp) {
+			return bp.getDebugProtocolBreakpoint(sessionId);
+		}
+		return undefined;
+	}
+
 	private sortAndDeDup(): void {
 		this.breakpoints = this.breakpoints.sort((first, second) => {
 			if (first.uri.toString() !== second.uri.toString()) {
diff --git a/src/vs/workbench/contrib/debug/test/common/mockDebug.ts b/src/vs/workbench/contrib/debug/test/common/mockDebug.ts
@@ -293,6 +293,9 @@ export class MockSession implements IDebugSession {
 	sendExceptionBreakpoints(exbpts: IExceptionBreakpoint[]): Promise<void> {
 		throw new Error('Method not implemented.');
 	}
+	getDebugProtocolBreakpoint(breakpointId: string): DebugProtocol.Breakpoint | undefined {
+		throw new Error('Method not implemented.');
+	}
 	customRequest(request: string, args: any): Promise<DebugProtocol.Response> {
 		throw new Error('Method not implemented.');
 	}

Original file line number	Diff line number	Diff line change
`@@ -957,6 +957,10 @@ export class ExtHostDebugSession implements vscode.DebugSession {`
`957`	`957`	`public customRequest(command: string, args: any): Promise<any> {`
`958`	`958`	`return this._debugServiceProxy.$customDebugAdapterRequest(this._id, command, args);`
`959`	`959`	`}`
	`960`	`+`
	`961`	`+ public getDebugProtocolBreakpoint(breakpoint: vscode.Breakpoint): vscode.DebugProtocolBreakpoint \| undefined {`
	`962`	`+ return this._debugServiceProxy.$getDebugProtocolBreakpoint(this._id, breakpoint.id);`
	`963`	`+ }`
`960`	`964`	`}`
`961`	`965`
`962`	`966`	`export class ExtHostDebugConsole implements vscode.DebugConsole {`
Original file line number	Diff line number	Diff line change
`@@ -293,6 +293,9 @@ export class MockSession implements IDebugSession {`
`293`	`293`	`sendExceptionBreakpoints(exbpts: IExceptionBreakpoint[]): Promise<void> {`
`294`	`294`	`throw new Error('Method not implemented.');`
`295`	`295`	`}`
	`296`	`+ getDebugProtocolBreakpoint(breakpointId: string): DebugProtocol.Breakpoint \| undefined {`
	`297`	`+ throw new Error('Method not implemented.');`
	`298`	`+ }`
`296`	`299`	`customRequest(request: string, args: any): Promise<DebugProtocol.Response> {`
`297`	`300`	`throw new Error('Method not implemented.');`
`298`	`301`	`}`