vscode.debugProtocol

Attach request; value of command field is 'attach'. The attach request is sent from the client to the debug adapter to attach to a debuggee that is already running. Since attaching is debugger/runtime specific, the arguments for this request are not part of this specification.

Arguments for 'attach' request. Additional attributes are implementation specific.

Response to 'attach' request. This is just an acknowledgement, so no body field is required.

Information about a Breakpoint created in setBreakpoints or setFunctionBreakpoints.

Event message for 'breakpoint' event type. The event indicates that some information about a breakpoint has changed.

Properties of a breakpoint location returned from the 'breakpointLocations' request.

Arguments for 'breakpointLocations' request.

BreakpointLocations request; value of command field is 'breakpointLocations'. The 'breakpointLocations' request returns all possible locations for source breakpoints in a given range. Clients should only call this request if the capability 'supportsBreakpointLocationsRequest' is true.

Response to 'breakpointLocations' request. Contains possible locations for source breakpoints.

Arguments for 'cancel' request.

Cancel request; value of command field is 'cancel'. The 'cancel' request is used by the frontend in two situations: - to indicate that it is no longer interested in the result produced by a specific request issued earlier - to cancel a progress sequence. Clients should only call this request if the capability 'supportsCancelRequest' is true. This request has a hint characteristic: a debug adapter can only be expected to make a 'best effort' in honouring this request but there are no guarantees. The 'cancel' request may return an error if it could not cancel an operation but a frontend should refrain from presenting this error to end users. A frontend client should only call this request if the capability 'supportsCancelRequest' is true. The request that got canceled still needs to send a response back. This can either be a normal result ('success' attribute true) or an error response ('success' attribute false and the 'message' set to 'cancelled'). Returning partial results from a cancelled request is possible but please note that a frontend client has no generic way for detecting that a response is partial or not. The progress that got cancelled still needs to send a 'progressEnd' event back. A client should not assume that progress just got cancelled after sending the 'cancel' request.

Response to 'cancel' request. This is just an acknowledgement, so no body field is required.

Information about the capabilities of a debug adapter.

Event message for 'capabilities' event type. The event indicates that one or more capabilities have changed. Since the capabilities are dependent on the frontend and its UI, it might not be possible to change that at random times (or too late). Consequently this event has a hint characteristic: a frontend can only be expected to make a 'best effort' in honouring individual capabilities but there are no guarantees. Only changed capabilities need to be included, all other capabilities keep their values.

The checksum of an item calculated by the specified algorithm.

A ColumnDescriptor specifies what module attribute to show in a column of the ModulesView, how to format it, and what the column's label should be. It is only used if the underlying UI actually supports this level of customization.

CompletionItems are the suggestions returned from the CompletionsRequest.

Arguments for 'completions' request.

Completions request; value of command field is 'completions'. Returns a list of possible completions for a given caret position and text. Clients should only call this request if the capability 'supportsCompletionsRequest' is true.

Response to 'completions' request.

Arguments for 'configurationDone' request.

ConfigurationDone request; value of command field is 'configurationDone'. This optional request indicates that the client has finished initialization of the debug adapter. So it is the last request in the sequence of configuration requests (which was started by the 'initialized' event). Clients should only call this request if the capability 'supportsConfigurationDoneRequest' is true.

Response to 'configurationDone' request. This is just an acknowledgement, so no body field is required.

Arguments for 'continue' request.

Continue request; value of command field is 'continue'. The request starts the debuggee to run again.

Response to 'continue' request.

Event message for 'continued' event type. The event indicates that the execution of the debuggee has continued. Please note: a debug adapter is not expected to send this event in response to a request that implies that execution continues, e.g. 'launch' or 'continue'. It is only necessary to send a 'continued' event if there was no previous request that implied this.

Properties of a data breakpoint passed to the setDataBreakpoints request.

Arguments for 'dataBreakpointInfo' request.

DataBreakpointInfo request; value of command field is 'dataBreakpointInfo'. Obtains information on a possible data breakpoint that could be set on an expression or variable. Clients should only call this request if the capability 'supportsDataBreakpoints' is true.

Response to 'dataBreakpointInfo' request.

Arguments for 'disassemble' request.

Disassemble request; value of command field is 'disassemble'. Disassembles code stored at the provided location. Clients should only call this request if the capability 'supportsDisassembleRequest' is true.

Response to 'disassemble' request.

Represents a single disassembled instruction.

Arguments for 'disconnect' request.

Disconnect request; value of command field is 'disconnect'. The 'disconnect' request is sent from the client to the debug adapter in order to stop debugging. It asks the debug adapter to disconnect from the debuggee and to terminate the debug adapter. If the debuggee has been started with the 'launch' request, the 'disconnect' request terminates the debuggee. If the 'attach' request was used to connect to the debuggee, 'disconnect' does not terminate the debuggee. This behavior can be controlled with the 'terminateDebuggee' argument (if supported by the debug adapter).

Response to 'disconnect' request. This is just an acknowledgement, so no body field is required.

On error (whenever 'success' is false), the body can provide more details.

Arguments for 'evaluate' request.

Evaluate request; value of command field is 'evaluate'. Evaluates the given expression in the context of the top most stack frame. The expression has access to any variables and arguments that are in scope.

Response to 'evaluate' request.

A debug adapter initiated event.

An ExceptionBreakpointsFilter is shown in the UI as an option for configuring how exceptions are dealt with.

Detailed information about an exception that has occurred.

Arguments for 'exceptionInfo' request.

ExceptionInfo request; value of command field is 'exceptionInfo'. Retrieves the details of the exception that caused this event to be raised. Clients should only call this request if the capability 'supportsExceptionInfoRequest' is true.

Response to 'exceptionInfo' request.

An ExceptionOptions assigns configuration options to a set of exceptions.

An ExceptionPathSegment represents a segment in a path that is used to match leafs or nodes in a tree of exceptions. If a segment consists of more than one name, it matches the names provided if 'negate' is false or missing or it matches anything except the names provided if 'negate' is true.

Event message for 'exited' event type. The event indicates that the debuggee has exited and returns its exit code.

Properties of a breakpoint passed to the setFunctionBreakpoints request.

Arguments for 'goto' request.

Goto request; value of command field is 'goto'. The request sets the location where the debuggee will continue to run. This makes it possible to skip the execution of code or to executed code again. The code between the current location and the goto target is not executed but skipped. The debug adapter first sends the response and then a 'stopped' event with reason 'goto'. Clients should only call this request if the capability 'supportsGotoTargetsRequest' is true (because only then goto targets exist that can be passed as arguments).

Response to 'goto' request. This is just an acknowledgement, so no body field is required.

A GotoTarget describes a code location that can be used as a target in the 'goto' request. The possible goto targets can be determined via the 'gotoTargets' request.

Arguments for 'gotoTargets' request.

GotoTargets request; value of command field is 'gotoTargets'. This request retrieves the possible goto targets for the specified source location. These targets can be used in the 'goto' request. Clients should only call this request if the capability 'supportsGotoTargetsRequest' is true.

Response to 'gotoTargets' request.

Initialize request; value of command field is 'initialize'. The 'initialize' request is sent as the first request from the client to the debug adapter in order to configure it with client capabilities and to retrieve capabilities from the debug adapter. Until the debug adapter has responded to with an 'initialize' response, the client must not send any additional requests or events to the debug adapter. In addition the debug adapter is not allowed to send any requests or events to the client until it has responded with an 'initialize' response. The 'initialize' request may only be sent once.

Arguments for 'initialize' request.

Response to 'initialize' request.

Event message for 'initialized' event type. This event indicates that the debug adapter is ready to accept configuration requests (e.g. SetBreakpointsRequest, SetExceptionBreakpointsRequest). A debug adapter is expected to send this event when it is ready to accept configuration requests (but not before the 'initialize' request has finished). The sequence of events/requests is as follows: - adapters sends 'initialized' event (after the 'initialize' request has returned) - frontend sends zero or more 'setBreakpoints' requests - frontend sends one 'setFunctionBreakpoints' request (if capability 'supportsFunctionBreakpoints' is true) - frontend sends a 'setExceptionBreakpoints' request if one or more 'exceptionBreakpointFilters' have been defined (or if 'supportsConfigurationDoneRequest' is not defined or false) - frontend sends other future configuration requests - frontend sends one 'configurationDone' request to indicate the end of the configuration.

Properties of a breakpoint passed to the setInstructionBreakpoints request

Launch request; value of command field is 'launch'. This launch request is sent from the client to the debug adapter to start the debuggee with or without debugging (if 'noDebug' is true). Since launching is debugger/runtime specific, the arguments for this request are not part of this specification.

Arguments for 'launch' request. Additional attributes are implementation specific.

Response to 'launch' request. This is just an acknowledgement, so no body field is required.

Event message for 'loadedSource' event type. The event indicates that some source has been added, changed, or removed from the set of all loaded sources.

Arguments for 'loadedSources' request.

LoadedSources request; value of command field is 'loadedSources'. Retrieves the set of all sources currently loaded by the debugged process. Clients should only call this request if the capability 'supportsLoadedSourcesRequest' is true.

Response to 'loadedSources' request.

A structured message object. Used to return errors from requests.

A Module object represents a row in the modules view. Two attributes are mandatory: an id identifies a module in the modules view and is used in a ModuleEvent for identifying a module for adding, updating or deleting. The name is used to minimally render the module in the UI.

Event message for 'module' event type. The event indicates that some information about a module has changed.

Arguments for 'modules' request.

Modules request; value of command field is 'modules'. Modules can be retrieved from the debug adapter with this request which can either return all modules or a range of modules to support paging. Clients should only call this request if the capability 'supportsModulesRequest' is true.

Response to 'modules' request.

The ModulesViewDescriptor is the container for all declarative configuration options of a ModuleView. For now it only specifies the columns to be shown in the modules view.

Arguments for 'next' request.

Next request; value of command field is 'next'. The request starts the debuggee to run again for one step. The debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.

Response to 'next' request. This is just an acknowledgement, so no body field is required.

Event message for 'output' event type. The event indicates that the target has produced some output.

Arguments for 'pause' request.

Pause request; value of command field is 'pause'. The request suspends the debuggee. The debug adapter first sends the response and then a 'stopped' event (with reason 'pause') after the thread has been paused successfully.

Response to 'pause' request. This is just an acknowledgement, so no body field is required.

Event message for 'process' event type. The event indicates that the debugger has begun debugging a new process. Either one that it has launched, or one that it has attached to.

Event message for 'progressEnd' event type. The event signals the end of the progress reporting with an optional final message. This event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.

Event message for 'progressStart' event type. The event signals that a long running operation is about to start and provides additional information for the client to set up a corresponding progress and cancellation UI. The client is free to delay the showing of the UI in order to reduce flicker. This event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.

Event message for 'progressUpdate' event type. The event signals that the progress reporting needs to updated with a new message and/or percentage. The client does not have to update the UI immediately, but the clients needs to keep track of the message and/or percentage values. This event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.

Base class of requests, responses, and events.

Arguments for 'readMemory' request.

ReadMemory request; value of command field is 'readMemory'. Reads bytes from memory at the provided location. Clients should only call this request if the capability 'supportsReadMemoryRequest' is true.

Response to 'readMemory' request.

A client or debug adapter initiated request.

Response to a request.

Arguments for 'restart' request.

Arguments for 'restartFrame' request.

RestartFrame request; value of command field is 'restartFrame'. The request restarts execution of the specified stackframe. The debug adapter first sends the response and then a 'stopped' event (with reason 'restart') after the restart has completed. Clients should only call this request if the capability 'supportsRestartFrame' is true.

Response to 'restartFrame' request. This is just an acknowledgement, so no body field is required.

Restart request; value of command field is 'restart'. Restarts a debug session. Clients should only call this request if the capability 'supportsRestartRequest' is true. If the capability is missing or has the value false, a typical client will emulate 'restart' by terminating the debug adapter first and then launching it anew.

Response to 'restart' request. This is just an acknowledgement, so no body field is required.

Arguments for 'reverseContinue' request.

ReverseContinue request; value of command field is 'reverseContinue'. The request starts the debuggee to run backward. Clients should only call this request if the capability 'supportsStepBack' is true.

Response to 'reverseContinue' request. This is just an acknowledgement, so no body field is required.

RunInTerminal request; value of command field is 'runInTerminal'. This optional request is sent from the debug adapter to the client to run a command in a terminal. This is typically used to launch the debuggee in a terminal provided by the client. This request should only be called if the client has passed the value true for the 'supportsRunInTerminalRequest' capability of the 'initialize' request.

Arguments for 'runInTerminal' request.

Response to Initialize request.

A Scope is a named container for variables. Optionally a scope can map to a source or a range within a source.

Arguments for 'scopes' request.

Scopes request; value of command field is 'scopes'. The request returns the variable scopes for a given stackframe ID.

Response to 'scopes' request.

Arguments for "setBreakpoints" request.

SetBreakpoints request; value of command field is 'setBreakpoints'. Sets multiple breakpoints for a single source and clears all previous breakpoints in that source. To clear all breakpoint for a source, specify an empty array. When a breakpoint is hit, a 'stopped' event (with reason 'breakpoint') is generated.

Response to 'setBreakpoints' request. Returned is information about each breakpoint created by this request. This includes the actual code location and whether the breakpoint could be verified. The breakpoints returned are in the same order as the elements of the 'breakpoints' (or the deprecated 'lines') array in the arguments.

Arguments for 'setDataBreakpoints' request.

SetDataBreakpoints request; value of command field is 'setDataBreakpoints'. Replaces all existing data breakpoints with new data breakpoints. To clear all data breakpoints, specify an empty array. When a data breakpoint is hit, a 'stopped' event (with reason 'data breakpoint') is generated. Clients should only call this request if the capability 'supportsDataBreakpoints' is true.

Response to 'setDataBreakpoints' request. Returned is information about each breakpoint created by this request.

Arguments for 'setExceptionBreakpoints' request.

SetExceptionBreakpoints request; value of command field is 'setExceptionBreakpoints'. The request configures the debuggers response to thrown exceptions. If an exception is configured to break, a 'stopped' event is fired (with reason 'exception'). Clients should only call this request if the capability 'exceptionBreakpointFilters' returns one or more filters

Response to 'setExceptionBreakpoints' request. This is just an acknowledgement, so no body field is required.

Arguments for 'setExpression' request.

SetExpression request; value of command field is 'setExpression'. Evaluates the given 'value' expression and assigns it to the 'expression' which must be a modifiable l-value. The expressions have access to any variables and arguments that are in scope of the specified frame. Clients should only call this request if the capability 'supportsSetExpression' is true.

Response to 'setExpression' request.

Arguments for 'setFunctionBreakpoints' request.

SetFunctionBreakpoints request; value of command field is 'setFunctionBreakpoints'. Replaces all existing function breakpoints with new function breakpoints. To clear all function breakpoints, specify an empty array. When a function breakpoint is hit, a 'stopped' event (with reason 'function breakpoint') is generated. Clients should only call this request if the capability 'supportsFunctionBreakpoints' is true.

Response to 'setFunctionBreakpoints' request. Returned is information about each breakpoint created by this request.

Arguments for 'setInstructionBreakpoints' request

SetInstructionBreakpoints request; value of command field is 'setInstructionBreakpoints'. Replaces all existing instruction breakpoints. Typically, instruction breakpoints would be set from a diassembly window. To clear all instruction breakpoints, specify an empty array. When an instruction breakpoint is hit, a 'stopped' event (with reason 'instruction breakpoint') is generated. Clients should only call this request if the capability 'supportsInstructionBreakpoints' is true.

Response to 'setInstructionBreakpoints' request

Arguments for 'setVariable' request.

SetVariable request; value of command field is 'setVariable'. Set the variable with the given name in the variable container to a new value. Clients should only call this request if the capability 'supportsSetVariable' is true.

Response to 'setVariable' request.

A Source is a descriptor for source code. It is returned from the debug adapter as part of a StackFrame and it is used by clients when specifying breakpoints.

Arguments for 'source' request.

Properties of a breakpoint passed to the setBreakpoints request.

Source request; value of command field is 'source'. The request retrieves the source code for a given source reference.

Response to 'source' request.

A Stackframe contains the source location.

Provides formatting information for a stack frame.

Arguments for 'stackTrace' request.

StackTrace request; value of command field is 'stackTrace'. The request returns a stacktrace from the current execution state.

Response to 'stackTrace' request.

Arguments for 'stepBack' request.

StepBack request; value of command field is 'stepBack'. The request starts the debuggee to run one step backwards. The debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed. Clients should only call this request if the capability 'supportsStepBack' is true.

Response to 'stepBack' request. This is just an acknowledgement, so no body field is required.

Arguments for 'stepIn' request.

StepIn request; value of command field is 'stepIn'. The request starts the debuggee to step into a function/method if possible. If it cannot step into a target, 'stepIn' behaves like 'next'. The debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed. If there are multiple function/method calls (or other targets) on the source line, the optional argument 'targetId' can be used to control into which target the 'stepIn' should occur. The list of possible targets for a given source line can be retrieved via the 'stepInTargets' request.

Response to 'stepIn' request. This is just an acknowledgement, so no body field is required.

A StepInTarget can be used in the 'stepIn' request and determines into which single target the stepIn request should step.

Arguments for 'stepInTargets' request.

StepInTargets request; value of command field is 'stepInTargets'. This request retrieves the possible stepIn targets for the specified stack frame. These targets can be used in the 'stepIn' request. The StepInTargets may only be called if the 'supportsStepInTargetsRequest' capability exists and is true. Clients should only call this request if the capability 'supportsStepInTargetsRequest' is true.

Response to 'stepInTargets' request.

Arguments for 'stepOut' request.

StepOut request; value of command field is 'stepOut'. The request starts the debuggee to run again for one step. The debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.

Response to 'stepOut' request. This is just an acknowledgement, so no body field is required.

Event message for 'stopped' event type. The event indicates that the execution of the debuggee has stopped due to some condition. This can be caused by a break point previously set, a stepping request has completed, by executing a debugger statement etc.

Arguments for 'terminate' request.

Terminate request; value of command field is 'terminate'. The 'terminate' request is sent from the client to the debug adapter in order to give the debuggee a chance for terminating itself. Clients should only call this request if the capability 'supportsTerminateRequest' is true.

Response to 'terminate' request. This is just an acknowledgement, so no body field is required.

Arguments for 'terminateThreads' request.

TerminateThreads request; value of command field is 'terminateThreads'. The request terminates the threads with the given ids. Clients should only call this request if the capability 'supportsTerminateThreadsRequest' is true.

Response to 'terminateThreads' request. This is just an acknowledgement, so no body field is required.

Event message for 'terminated' event type. The event indicates that debugging of the debuggee has terminated. This does not mean that the debuggee itself has exited.

A Thread

Event message for 'thread' event type. The event indicates that a thread has started or exited.

Threads request; value of command field is 'threads'. The request retrieves a list of all threads.

Response to 'threads' request.

Provides formatting information for a value.

A Variable is a name/value pair. Optionally a variable can have a 'type' that is shown if space permits or when hovering over the variable's name. An optional 'kind' is used to render additional properties of the variable, e.g. different icons can be used to indicate that a variable is public or private. If the value is structured (has children), a handle is provided to retrieve the children with the VariablesRequest. If the number of named or indexed children is large, the numbers should be returned via the optional 'namedVariables' and 'indexedVariables' attributes. The client can use this optional information to present the children in a paged UI and fetch them in chunks.

Optional properties of a variable that can be used to determine how to render the variable in the UI.

Arguments for 'variables' request.

Variables request; value of command field is 'variables'. Retrieves all child variables for the given variable reference. An optional filter can be used to limit the fetched children to either named or indexed children.

Response to 'variables' request.