Add a "type" field for SourceBreakpoints #454
Description
Splitting off from #445
The original authors requested the capability to present hard vs soft breakpoints.
Hardware breakpoints are useful in a variety of low-level and embedded computing scenarios. They are supported on major architectures and by debugging such as gdb (the hbreak family of commands).
Unlike software breakpoints, they are usually limited in number. I do not think we need any new way to express this limit, as DA's can already return a message explaining why a Breakpoint may not have been verified. This I propose the following additions:
interface Capabilities {
// ... in addition to exisitng properties:
/**
* Types of breakpoints supported by the debug adapter. If present, the client
* may allow the user to select a type and include it in its `setBreakpoints` request.
*/
breakpointTypes?: BreakpointType[];
// ...
}
// borrowing properties from the `ExceptionBreakpointsFilter`:
interface BreakpointType {
/**
* The internal ID of the breakpoint type. This value is passed to the
* `setBreakpoints` request.
*/
type: string;
/**
* The name of the breakpoint type. This is shown in the UI.
*/
label: string;
/**
* A help text providing additional information about the breakpoint type.
* This string is typically shown as a hover and can be translated.
*/
description?: string;
}
interface SourceBreakpoint {
// ... in addition to exisitng properties:
/**
* The type of this breakpoint. This must be one of the `breakpointTypes` the
* debug adapter advertised in its Capabilities.
*/
type?: string;
}