debug
Properties
The currently active debug console. If no debug session is active, output sent to the debug console is not shown.
The currently active debug session or undefined
. The active debug session is the one represented by the debug action floating window or the one currently shown in the drop down menu of the debug action floating window. If no debug session is active, the value is undefined
.
The currently focused thread or stack frame, or undefined
if no thread or stack is focused. A thread can be focused any time there is an active debug session, while a stack frame can only be focused when a session is paused and the call stack has been retrieved.
List of breakpoints.
An Event which fires when the active debug session has changed. Note that the event also fires when the active debug session changes to undefined
.
An event which fires when the debug.activeStackItem has changed.
An Event that is emitted when the set of breakpoints is added, removed, or changed.
An Event which fires when a custom DAP event is received from the debug session.
An Event which fires when a new debug session has been started.
An Event which fires when a debug session has terminated.
Functions
Add breakpoints.
Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents. If the source descriptor is based on a path, a file Uri is returned. If the source descriptor uses a reference number, a specific debug Uri (scheme 'debug') is constructed that requires a corresponding ContentProvider and a running debug session
Register a debug adapter descriptor factory for a specific debug type. An extension is only allowed to register a DebugAdapterDescriptorFactory for the debug type(s) defined by the extension. Otherwise an error is thrown. Registering more than one DebugAdapterDescriptorFactory for a debug type results in an error.
Register a debug adapter tracker factory for the given debug type.
Register a debug configuration provider for a specific debug type. The optional triggerKind can be used to specify when the provideDebugConfigurations
method of the provider is triggered. Currently two trigger kinds are possible: with the value Initial
(or if no trigger kind argument is given) the provideDebugConfigurations
method is used to provide the initial debug configurations to be copied into a newly created launch.json. With the trigger kind Dynamic
the provideDebugConfigurations
method is used to dynamically determine debug configurations to be presented to the user (in addition to the static configurations from the launch.json). Please note that the triggerKind
argument only applies to the provideDebugConfigurations
method: so the resolveDebugConfiguration
methods are not affected at all. Registering a single provider with resolve methods for different trigger kinds, results in the same resolve methods called multiple times. More than one provider can be registered for the same type.
Remove breakpoints.
Start debugging by using either a named launch or named compound configuration, or by directly passing a DebugConfiguration. The named configurations are looked up in '.vscode/launch.json' found in the given folder. Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date. Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.
Stop the given debug session or stop all debug sessions if session is omitted.