From 2d197e4c60898244a49b2bb7f3ddb43d533764df Mon Sep 17 00:00:00 2001 From: Danny Tuppeny Date: Tue, 20 Jun 2023 17:29:24 +0000 Subject: [PATCH] [dap] Regenerate DAP classes based on latest published version of spec A lot of this change is just documentation comments, but it includes some minor updates such as supporting "lazy" on variables. All changes are backwards compatible and this should not affect any tests or functionality of Dart's DAP implementation (but provides the ability for us to use the new features). Change-Id: Ief81927f2f370b4bfb6b5a9acc8659c45c33ea18 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/310161 Reviewed-by: Ben Konyi Commit-Queue: Ben Konyi --- pkg/dap/CHANGELOG.md | 4 + pkg/dap/lib/src/protocol_generated.dart | 1847 +++++++++++------ pkg/dap/pubspec.yaml | 2 +- .../debugAdapterProtocol.json | 1085 ++++++---- 4 files changed, 1849 insertions(+), 1089 deletions(-) diff --git a/pkg/dap/CHANGELOG.md b/pkg/dap/CHANGELOG.md index 85ea7506557..f592145f185 100644 --- a/pkg/dap/CHANGELOG.md +++ b/pkg/dap/CHANGELOG.md @@ -1,3 +1,7 @@ +## 1.1.0 + +- Updated all generated classes using the latest published version of the DAP spec. + ## 1.0.0 - Moved DAP classes from `package:dds` into a standalone package. diff --git a/pkg/dap/lib/src/protocol_generated.dart b/pkg/dap/lib/src/protocol_generated.dart index f49ab4af8db..58b637d0eb0 100644 --- a/pkg/dap/lib/src/protocol_generated.dart +++ b/pkg/dap/lib/src/protocol_generated.dart @@ -9,11 +9,11 @@ import 'protocol_common.dart'; import 'protocol_special.dart'; -/// Arguments for 'attach' request. Additional attributes are implementation +/// Arguments for `attach` request. Additional attributes are implementation /// specific. class AttachRequestArguments extends RequestArguments { - /// Optional data from the previous, restarted session. - /// The data is sent as the 'restart' attribute of the 'terminated' event. + /// Arbitrary data from the previous, restarted session. + /// The data is sent as the `restart` attribute of the `terminated` event. /// The client should leave the data intact. final Object? restart; @@ -39,7 +39,7 @@ class AttachRequestArguments extends RequestArguments { }; } -/// Response to 'attach' request. This is just an acknowledgement, so no body +/// Response to `attach` request. This is just an acknowledgement, so no body /// field is required. class AttachResponse extends Response { static AttachResponse fromJson(Map obj) => @@ -76,43 +76,48 @@ class AttachResponse extends Response { }; } -/// Information about a Breakpoint created in setBreakpoints, -/// setFunctionBreakpoints, setInstructionBreakpoints, or setDataBreakpoints. +/// Information about a breakpoint created in `setBreakpoints`, +/// `setFunctionBreakpoints`, `setInstructionBreakpoints`, or +/// `setDataBreakpoints` requests. class Breakpoint { - /// An optional start column of the actual range covered by the breakpoint. + /// Start position of the source range covered by the breakpoint. It is + /// measured in UTF-16 code units and the client capability `columnsStartAt1` + /// determines whether it is 0- or 1-based. final int? column; - /// An optional end column of the actual range covered by the breakpoint. + /// End position of the source range covered by the breakpoint. It is measured + /// in UTF-16 code units and the client capability `columnsStartAt1` + /// determines whether it is 0- or 1-based. /// If no end line is given, then the end column is assumed to be in the start /// line. final int? endColumn; - /// An optional end line of the actual range covered by the breakpoint. + /// The end line of the actual range covered by the breakpoint. final int? endLine; - /// An optional identifier for the breakpoint. It is needed if breakpoint - /// events are used to update or remove breakpoints. + /// The identifier for the breakpoint. It is needed if breakpoint events are + /// used to update or remove breakpoints. final int? id; - /// An optional memory reference to where the breakpoint is set. + /// A memory reference to where the breakpoint is set. final String? instructionReference; /// The start line of the actual range covered by the breakpoint. final int? line; - /// An optional message about the state of the breakpoint. + /// A message about the state of the breakpoint. /// This is shown to the user and can be used to explain why a breakpoint /// could not be verified. final String? message; - /// An optional offset from the instruction reference. + /// The offset from the instruction reference. /// This can be negative. final int? offset; /// The source where the breakpoint is located. final Source? source; - /// If true breakpoint could be set (but not necessarily at the desired + /// If true, the breakpoint could be set (but not necessarily at the desired /// location). final bool verified; @@ -198,16 +203,20 @@ class Breakpoint { }; } -/// Properties of a breakpoint location returned from the 'breakpointLocations' +/// Properties of a breakpoint location returned from the `breakpointLocations` /// request. class BreakpointLocation { - /// Optional start column of breakpoint location. + /// The start position of a breakpoint location. Position is measured in + /// UTF-16 code units and the client capability `columnsStartAt1` determines + /// whether it is 0- or 1-based. final int? column; - /// Optional end column of breakpoint location if the location covers a range. + /// The end position of a breakpoint location (if the location covers a + /// range). Position is measured in UTF-16 code units and the client + /// capability `columnsStartAt1` determines whether it is 0- or 1-based. final int? endColumn; - /// Optional end line of breakpoint location if the location covers a range. + /// The end line of breakpoint location if the location covers a range. final int? endLine; /// Start line of breakpoint location. @@ -256,20 +265,22 @@ class BreakpointLocation { }; } -/// Arguments for 'breakpointLocations' request. +/// Arguments for `breakpointLocations` request. class BreakpointLocationsArguments extends RequestArguments { - /// Optional start column of range to search possible breakpoint locations in. - /// If no start column is given, the first column in the start line is - /// assumed. + /// Start position within `line` to search possible breakpoint locations in. + /// It is measured in UTF-16 code units and the client capability + /// `columnsStartAt1` determines whether it is 0- or 1-based. If no column is + /// given, the first position in the start line is assumed. final int? column; - /// Optional end column of range to search possible breakpoint locations in. - /// If no end column is given, then it is assumed to be in the last column of - /// the end line. + /// End position within `endLine` to search possible breakpoint locations in. + /// It is measured in UTF-16 code units and the client capability + /// `columnsStartAt1` determines whether it is 0- or 1-based. If no end column + /// is given, the last position in the end line is assumed. final int? endColumn; - /// Optional end line of range to search possible breakpoint locations in. If - /// no end line is given, then the end line is assumed to be the start line. + /// End line of range to search possible breakpoint locations in. If no end + /// line is given, then the end line is assumed to be the start line. final int? endLine; /// Start line of range to search possible breakpoint locations in. If only @@ -277,8 +288,8 @@ class BreakpointLocationsArguments extends RequestArguments { /// line. final int line; - /// The source location of the breakpoints; either 'source.path' or - /// 'source.reference' must be specified. + /// The source location of the breakpoints; either `source.path` or + /// `source.reference` must be specified. final Source source; static BreakpointLocationsArguments fromJson(Map obj) => @@ -330,7 +341,7 @@ class BreakpointLocationsArguments extends RequestArguments { }; } -/// Response to 'breakpointLocations' request. +/// Response to `breakpointLocations` request. /// Contains possible locations for source breakpoints. class BreakpointLocationsResponse extends Response { static BreakpointLocationsResponse fromJson(Map obj) => @@ -371,16 +382,16 @@ class BreakpointLocationsResponse extends Response { }; } -/// Arguments for 'cancel' request. +/// Arguments for `cancel` request. class CancelArguments extends RequestArguments { - /// The ID (attribute 'progressId') of the progress to cancel. If missing no + /// The ID (attribute `progressId`) of the progress to cancel. If missing no /// progress is cancelled. - /// Both a 'requestId' and a 'progressId' can be specified in one request. + /// Both a `requestId` and a `progressId` can be specified in one request. final String? progressId; - /// The ID (attribute 'seq') of the request to cancel. If missing no request + /// The ID (attribute `seq`) of the request to cancel. If missing no request /// is cancelled. - /// Both a 'requestId' and a 'progressId' can be specified in one request. + /// Both a `requestId` and a `progressId` can be specified in one request. final int? requestId; static CancelArguments fromJson(Map obj) => @@ -414,7 +425,7 @@ class CancelArguments extends RequestArguments { }; } -/// Response to 'cancel' request. This is just an acknowledgement, so no body +/// Response to `cancel` request. This is just an acknowledgement, so no body /// field is required. class CancelResponse extends Response { static CancelResponse fromJson(Map obj) => @@ -457,73 +468,73 @@ class Capabilities { final List? additionalModuleColumns; /// The set of characters that should trigger completion in a REPL. If not - /// specified, the UI should assume the '.' character. + /// specified, the UI should assume the `.` character. final List? completionTriggerCharacters; - /// Available exception filter options for the 'setExceptionBreakpoints' + /// Available exception filter options for the `setExceptionBreakpoints` /// request. final List? exceptionBreakpointFilters; - /// The debug adapter supports the 'suspendDebuggee' attribute on the - /// 'disconnect' request. + /// The debug adapter supports the `suspendDebuggee` attribute on the + /// `disconnect` request. final bool? supportSuspendDebuggee; - /// The debug adapter supports the 'terminateDebuggee' attribute on the - /// 'disconnect' request. + /// The debug adapter supports the `terminateDebuggee` attribute on the + /// `disconnect` request. final bool? supportTerminateDebuggee; /// Checksum algorithms supported by the debug adapter. final List? supportedChecksumAlgorithms; - /// The debug adapter supports the 'breakpointLocations' request. + /// The debug adapter supports the `breakpointLocations` request. final bool? supportsBreakpointLocationsRequest; - /// The debug adapter supports the 'cancel' request. + /// The debug adapter supports the `cancel` request. final bool? supportsCancelRequest; - /// The debug adapter supports the 'clipboard' context value in the 'evaluate' + /// The debug adapter supports the `clipboard` context value in the `evaluate` /// request. final bool? supportsClipboardContext; - /// The debug adapter supports the 'completions' request. + /// The debug adapter supports the `completions` request. final bool? supportsCompletionsRequest; /// The debug adapter supports conditional breakpoints. final bool? supportsConditionalBreakpoints; - /// The debug adapter supports the 'configurationDone' request. + /// The debug adapter supports the `configurationDone` request. final bool? supportsConfigurationDoneRequest; /// The debug adapter supports data breakpoints. final bool? supportsDataBreakpoints; /// The debug adapter supports the delayed loading of parts of the stack, - /// which requires that both the 'startFrame' and 'levels' arguments and an - /// optional 'totalFrames' result of the 'StackTrace' request are supported. + /// which requires that both the `startFrame` and `levels` arguments and the + /// `totalFrames` result of the `stackTrace` request are supported. final bool? supportsDelayedStackTraceLoading; - /// The debug adapter supports the 'disassemble' request. + /// The debug adapter supports the `disassemble` request. final bool? supportsDisassembleRequest; - /// The debug adapter supports a (side effect free) evaluate request for data - /// hovers. + /// The debug adapter supports a (side effect free) `evaluate` request for + /// data hovers. final bool? supportsEvaluateForHovers; - /// The debug adapter supports 'filterOptions' as an argument on the - /// 'setExceptionBreakpoints' request. + /// The debug adapter supports `filterOptions` as an argument on the + /// `setExceptionBreakpoints` request. final bool? supportsExceptionFilterOptions; - /// The debug adapter supports the 'exceptionInfo' request. + /// The debug adapter supports the `exceptionInfo` request. final bool? supportsExceptionInfoRequest; - /// The debug adapter supports 'exceptionOptions' on the - /// setExceptionBreakpoints request. + /// The debug adapter supports `exceptionOptions` on the + /// `setExceptionBreakpoints` request. final bool? supportsExceptionOptions; /// The debug adapter supports function breakpoints. final bool? supportsFunctionBreakpoints; - /// The debug adapter supports the 'gotoTargets' request. + /// The debug adapter supports the `gotoTargets` request. final bool? supportsGotoTargetsRequest; /// The debug adapter supports breakpoints that break execution after a @@ -534,54 +545,62 @@ class Capabilities { /// references. final bool? supportsInstructionBreakpoints; - /// The debug adapter supports the 'loadedSources' request. + /// The debug adapter supports the `loadedSources` request. final bool? supportsLoadedSourcesRequest; - /// The debug adapter supports logpoints by interpreting the 'logMessage' - /// attribute of the SourceBreakpoint. + /// The debug adapter supports log points by interpreting the `logMessage` + /// attribute of the `SourceBreakpoint`. final bool? supportsLogPoints; - /// The debug adapter supports the 'modules' request. + /// The debug adapter supports the `modules` request. final bool? supportsModulesRequest; - /// The debug adapter supports the 'readMemory' request. + /// The debug adapter supports the `readMemory` request. final bool? supportsReadMemoryRequest; /// The debug adapter supports restarting a frame. final bool? supportsRestartFrame; - /// The debug adapter supports the 'restart' request. In this case a client - /// should not implement 'restart' by terminating and relaunching the adapter - /// but by calling the RestartRequest. + /// The debug adapter supports the `restart` request. In this case a client + /// should not implement `restart` by terminating and relaunching the adapter + /// but by calling the `restart` request. final bool? supportsRestartRequest; - /// The debug adapter supports the 'setExpression' request. + /// The debug adapter supports the `setExpression` request. final bool? supportsSetExpression; /// The debug adapter supports setting a variable to a value. final bool? supportsSetVariable; - /// The debug adapter supports stepping back via the 'stepBack' and - /// 'reverseContinue' requests. + /// The debug adapter supports the `singleThread` property on the execution + /// requests (`continue`, `next`, `stepIn`, `stepOut`, `reverseContinue`, + /// `stepBack`). + final bool? supportsSingleThreadExecutionRequests; + + /// The debug adapter supports stepping back via the `stepBack` and + /// `reverseContinue` requests. final bool? supportsStepBack; - /// The debug adapter supports the 'stepInTargets' request. + /// The debug adapter supports the `stepInTargets` request. final bool? supportsStepInTargetsRequest; - /// The debug adapter supports stepping granularities (argument 'granularity') + /// The debug adapter supports stepping granularities (argument `granularity`) /// for the stepping requests. final bool? supportsSteppingGranularity; - /// The debug adapter supports the 'terminate' request. + /// The debug adapter supports the `terminate` request. final bool? supportsTerminateRequest; - /// The debug adapter supports the 'terminateThreads' request. + /// The debug adapter supports the `terminateThreads` request. final bool? supportsTerminateThreadsRequest; - /// The debug adapter supports a 'format' attribute on the stackTraceRequest, - /// variablesRequest, and evaluateRequest. + /// The debug adapter supports a `format` attribute on the `stackTrace`, + /// `variables`, and `evaluate` requests. final bool? supportsValueFormattingOptions; + /// The debug adapter supports the `writeMemory` request. + final bool? supportsWriteMemoryRequest; + static Capabilities fromJson(Map obj) => Capabilities.fromMap(obj); @@ -617,12 +636,14 @@ class Capabilities { this.supportsRestartRequest, this.supportsSetExpression, this.supportsSetVariable, + this.supportsSingleThreadExecutionRequests, this.supportsStepBack, this.supportsStepInTargetsRequest, this.supportsSteppingGranularity, this.supportsTerminateRequest, this.supportsTerminateThreadsRequest, this.supportsValueFormattingOptions, + this.supportsWriteMemoryRequest, }); Capabilities.fromMap(Map obj) @@ -680,6 +701,8 @@ class Capabilities { supportsRestartRequest = obj['supportsRestartRequest'] as bool?, supportsSetExpression = obj['supportsSetExpression'] as bool?, supportsSetVariable = obj['supportsSetVariable'] as bool?, + supportsSingleThreadExecutionRequests = + obj['supportsSingleThreadExecutionRequests'] as bool?, supportsStepBack = obj['supportsStepBack'] as bool?, supportsStepInTargetsRequest = obj['supportsStepInTargetsRequest'] as bool?, @@ -689,7 +712,8 @@ class Capabilities { supportsTerminateThreadsRequest = obj['supportsTerminateThreadsRequest'] as bool?, supportsValueFormattingOptions = - obj['supportsValueFormattingOptions'] as bool?; + obj['supportsValueFormattingOptions'] as bool?, + supportsWriteMemoryRequest = obj['supportsWriteMemoryRequest'] as bool?; static bool canParse(Object? obj) { if (obj is! Map) { @@ -795,6 +819,9 @@ class Capabilities { if (obj['supportsSetVariable'] is! bool?) { return false; } + if (obj['supportsSingleThreadExecutionRequests'] is! bool?) { + return false; + } if (obj['supportsStepBack'] is! bool?) { return false; } @@ -813,6 +840,9 @@ class Capabilities { if (obj['supportsValueFormattingOptions'] is! bool?) { return false; } + if (obj['supportsWriteMemoryRequest'] is! bool?) { + return false; + } return true; } @@ -880,6 +910,9 @@ class Capabilities { 'supportsSetExpression': supportsSetExpression, if (supportsSetVariable != null) 'supportsSetVariable': supportsSetVariable, + if (supportsSingleThreadExecutionRequests != null) + 'supportsSingleThreadExecutionRequests': + supportsSingleThreadExecutionRequests, if (supportsStepBack != null) 'supportsStepBack': supportsStepBack, if (supportsStepInTargetsRequest != null) 'supportsStepInTargetsRequest': supportsStepInTargetsRequest, @@ -891,6 +924,8 @@ class Capabilities { 'supportsTerminateThreadsRequest': supportsTerminateThreadsRequest, if (supportsValueFormattingOptions != null) 'supportsValueFormattingOptions': supportsValueFormattingOptions, + if (supportsWriteMemoryRequest != null) + 'supportsWriteMemoryRequest': supportsWriteMemoryRequest, }; } @@ -899,7 +934,7 @@ class Checksum { /// The algorithm used to calculate this checksum. final ChecksumAlgorithm algorithm; - /// Value of the checksum. + /// Value of the checksum, encoded as a hexadecimal value. final String checksum; static Checksum fromJson(Map obj) => Checksum.fromMap(obj); @@ -935,8 +970,8 @@ class Checksum { /// Names of checksum algorithms that may be supported by a debug adapter. typedef ChecksumAlgorithm = String; -/// A ColumnDescriptor specifies what module attribute to show in a column of -/// the ModulesView, how to format it, +/// A `ColumnDescriptor` specifies what module attribute to show in a column of +/// the modules view, 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. @@ -951,7 +986,7 @@ class ColumnDescriptor { /// Header UI label of column. final String label; - /// Datatype of values in this column. Defaults to 'string' if not specified. + /// Datatype of values in this column. Defaults to `string` if not specified. final String? type; /// Width of this column in characters (hint only). @@ -1006,41 +1041,48 @@ class ColumnDescriptor { }; } -/// CompletionItems are the suggestions returned from the CompletionsRequest. +/// `CompletionItems` are the suggestions returned from the `completions` +/// request. class CompletionItem { + /// A human-readable string with additional information about this item, like + /// type or symbol information. + final String? detail; + /// The label of this completion item. By default this is also the text that /// is inserted when selecting this completion. final String label; - /// This value determines how many characters are overwritten by the - /// completion text. - /// If missing the value 0 is assumed which results in the completion text - /// being inserted. + /// Length determines how many characters are overwritten by the completion + /// text and it is measured in UTF-16 code units. If missing the value 0 is + /// assumed which results in the completion text being inserted. final int? length; /// Determines the length of the new selection after the text has been - /// inserted (or replaced). - /// The selection can not extend beyond the bounds of the completion text. - /// If omitted the length is assumed to be 0. + /// inserted (or replaced) and it is measured in UTF-16 code units. The + /// selection can not extend beyond the bounds of the completion text. If + /// omitted the length is assumed to be 0. final int? selectionLength; /// Determines the start of the new selection after the text has been inserted - /// (or replaced). - /// The start position must in the range 0 and length of the completion text. - /// If omitted the selection starts at the end of the completion text. + /// (or replaced). `selectionStart` is measured in UTF-16 code units and must + /// be in the range 0 and length of the completion text. If omitted the + /// selection starts at the end of the completion text. final int? selectionStart; - /// A string that should be used when comparing this item with other items. - /// When `falsy` the label is used. + /// A string that should be used when comparing this item with other items. If + /// not returned or an empty string, the `label` is used instead. final String? sortText; - /// This value determines the location (in the CompletionsRequest's 'text' - /// attribute) where the completion text is added. - /// If missing the text is added at the location specified by the - /// CompletionsRequest's 'column' attribute. + /// Start position (within the `text` attribute of the `completions` request) + /// where the completion text is added. The position is measured in UTF-16 + /// code units and the client capability `columnsStartAt1` determines whether + /// it is 0- or 1-based. If the start position is omitted the text is added at + /// the location specified by the `column` attribute of the `completions` + /// request. final int? start; - /// If text is not falsy then it is inserted instead of the label. + /// If text is returned and not an empty string, then it is inserted instead + /// of the label. final String? text; /// The item's type. Typically the client uses this information to render the @@ -1051,6 +1093,7 @@ class CompletionItem { CompletionItem.fromMap(obj); CompletionItem({ + this.detail, required this.label, this.length, this.selectionLength, @@ -1062,7 +1105,8 @@ class CompletionItem { }); CompletionItem.fromMap(Map obj) - : label = obj['label'] as String, + : detail = obj['detail'] as String?, + label = obj['label'] as String, length = obj['length'] as int?, selectionLength = obj['selectionLength'] as int?, selectionStart = obj['selectionStart'] as int?, @@ -1075,6 +1119,9 @@ class CompletionItem { if (obj is! Map) { return false; } + if (obj['detail'] is! String?) { + return false; + } if (obj['label'] is! String) { return false; } @@ -1103,6 +1150,7 @@ class CompletionItem { } Map toJson() => { + if (detail != null) 'detail': detail, 'label': label, if (length != null) 'length': length, if (selectionLength != null) 'selectionLength': selectionLength, @@ -1118,21 +1166,23 @@ class CompletionItem { /// clients have specific icons for all of them. typedef CompletionItemType = String; -/// Arguments for 'completions' request. +/// Arguments for `completions` request. class CompletionsArguments extends RequestArguments { - /// The character position for which to determine the completion proposals. + /// The position within `text` for which to determine the completion + /// proposals. It is measured in UTF-16 code units and the client capability + /// `columnsStartAt1` determines whether it is 0- or 1-based. final int column; /// Returns completions in the scope of this stack frame. If not specified, /// the completions are returned for the global scope. final int? frameId; - /// An optional line for which to determine the completion proposals. If - /// missing the first line of the text is assumed. + /// A line for which to determine the completion proposals. If missing the + /// first line of the text is assumed. final int? line; - /// One or more source lines. Typically this is the text a user has typed into - /// the debug console before he asked for completion. + /// One or more source lines. Typically this is the text users have typed into + /// the debug console before they asked for completion. final String text; static CompletionsArguments fromJson(Map obj) => @@ -1178,7 +1228,7 @@ class CompletionsArguments extends RequestArguments { }; } -/// Response to 'completions' request. +/// Response to `completions` request. class CompletionsResponse extends Response { static CompletionsResponse fromJson(Map obj) => CompletionsResponse.fromMap(obj); @@ -1217,7 +1267,7 @@ class CompletionsResponse extends Response { }; } -/// Arguments for 'configurationDone' request. +/// Arguments for `configurationDone` request. class ConfigurationDoneArguments extends RequestArguments { static ConfigurationDoneArguments fromJson(Map obj) => ConfigurationDoneArguments.fromMap(obj); @@ -1236,7 +1286,7 @@ class ConfigurationDoneArguments extends RequestArguments { Map toJson() => {}; } -/// Response to 'configurationDone' request. This is just an acknowledgement, so +/// Response to `configurationDone` request. This is just an acknowledgement, so /// no body field is required. class ConfigurationDoneResponse extends Response { static ConfigurationDoneResponse fromJson(Map obj) => @@ -1274,28 +1324,36 @@ class ConfigurationDoneResponse extends Response { }; } -/// Arguments for 'continue' request. +/// Arguments for `continue` request. class ContinueArguments extends RequestArguments { - /// Continue execution for the specified thread (if possible). - /// If the backend cannot continue on a single thread but will continue on all - /// threads, it should set the 'allThreadsContinued' attribute in the response - /// to true. + /// If this flag is true, execution is resumed only for the thread with given + /// `threadId`. + final bool? singleThread; + + /// Specifies the active thread. If the debug adapter supports single thread + /// execution (see `supportsSingleThreadExecutionRequests`) and the argument + /// `singleThread` is true, only the thread with this ID is resumed. final int threadId; static ContinueArguments fromJson(Map obj) => ContinueArguments.fromMap(obj); ContinueArguments({ + this.singleThread, required this.threadId, }); ContinueArguments.fromMap(Map obj) - : threadId = obj['threadId'] as int; + : singleThread = obj['singleThread'] as bool?, + threadId = obj['threadId'] as int; static bool canParse(Object? obj) { if (obj is! Map) { return false; } + if (obj['singleThread'] is! bool?) { + return false; + } if (obj['threadId'] is! int) { return false; } @@ -1303,11 +1361,12 @@ class ContinueArguments extends RequestArguments { } Map toJson() => { + if (singleThread != null) 'singleThread': singleThread, 'threadId': threadId, }; } -/// Response to 'continue' request. +/// Response to `continue` request. class ContinueResponse extends Response { static ContinueResponse fromJson(Map obj) => ContinueResponse.fromMap(obj); @@ -1346,21 +1405,20 @@ class ContinueResponse extends Response { }; } -/// Properties of a data breakpoint passed to the setDataBreakpoints request. +/// Properties of a data breakpoint passed to the `setDataBreakpoints` request. class DataBreakpoint { /// The access type of the data. final DataBreakpointAccessType? accessType; - /// An optional expression for conditional breakpoints. + /// An expression for conditional breakpoints. final String? condition; /// An id representing the data. This id is returned from the - /// dataBreakpointInfo request. + /// `dataBreakpointInfo` request. final String dataId; - /// An optional expression that controls how many hits of the breakpoint are - /// ignored. - /// The backend is expected to interpret the expression as needed. + /// An expression that controls how many hits of the breakpoint are ignored. + /// The debug adapter is expected to interpret the expression as needed. final String? hitCondition; static DataBreakpoint fromJson(Map obj) => @@ -1409,33 +1467,45 @@ class DataBreakpoint { /// This enumeration defines all possible access types for data breakpoints. typedef DataBreakpointAccessType = String; -/// Arguments for 'dataBreakpointInfo' request. +/// Arguments for `dataBreakpointInfo` request. class DataBreakpointInfoArguments extends RequestArguments { - /// The name of the Variable's child to obtain data breakpoint information + /// When `name` is an expression, evaluate it in the scope of this stack + /// frame. If not specified, the expression is evaluated in the global scope. + /// When `variablesReference` is specified, this property has no effect. + final int? frameId; + + /// The name of the variable's child to obtain data breakpoint information /// for. - /// If variablesReference isn’t provided, this can be an expression. + /// If `variablesReference` isn't specified, this can be an expression. final String name; - /// Reference to the Variable container if the data breakpoint is requested - /// for a child of the container. + /// Reference to the variable container if the data breakpoint is requested + /// for a child of the container. The `variablesReference` must have been + /// obtained in the current suspended state. See 'Lifetime of Object + /// References' in the Overview section for details. final int? variablesReference; static DataBreakpointInfoArguments fromJson(Map obj) => DataBreakpointInfoArguments.fromMap(obj); DataBreakpointInfoArguments({ + this.frameId, required this.name, this.variablesReference, }); DataBreakpointInfoArguments.fromMap(Map obj) - : name = obj['name'] as String, + : frameId = obj['frameId'] as int?, + name = obj['name'] as String, variablesReference = obj['variablesReference'] as int?; static bool canParse(Object? obj) { if (obj is! Map) { return false; } + if (obj['frameId'] is! int?) { + return false; + } if (obj['name'] is! String) { return false; } @@ -1446,13 +1516,14 @@ class DataBreakpointInfoArguments extends RequestArguments { } Map toJson() => { + if (frameId != null) 'frameId': frameId, 'name': name, if (variablesReference != null) 'variablesReference': variablesReference, }; } -/// Response to 'dataBreakpointInfo' request. +/// Response to `dataBreakpointInfo` request. class DataBreakpointInfoResponse extends Response { static DataBreakpointInfoResponse fromJson(Map obj) => DataBreakpointInfoResponse.fromMap(obj); @@ -1492,7 +1563,7 @@ class DataBreakpointInfoResponse extends Response { }; } -/// Arguments for 'disassemble' request. +/// Arguments for `disassemble` request. class DisassembleArguments extends RequestArguments { /// Number of instructions to disassemble starting at the specified location /// and offset. @@ -1501,15 +1572,15 @@ class DisassembleArguments extends RequestArguments { /// 'invalid instruction' value. final int instructionCount; - /// Optional offset (in instructions) to be applied after the byte offset (if - /// any) before disassembling. Can be negative. + /// Offset (in instructions) to be applied after the byte offset (if any) + /// before disassembling. Can be negative. final int? instructionOffset; /// Memory reference to the base location containing the instructions to /// disassemble. final String memoryReference; - /// Optional offset (in bytes) to be applied to the reference location before + /// Offset (in bytes) to be applied to the reference location before /// disassembling. Can be negative. final int? offset; @@ -1566,7 +1637,7 @@ class DisassembleArguments extends RequestArguments { }; } -/// Response to 'disassemble' request. +/// Response to `disassemble` request. class DisassembleResponse extends Response { static DisassembleResponse fromJson(Map obj) => DisassembleResponse.fromMap(obj); @@ -1608,7 +1679,7 @@ class DisassembleResponse extends Response { /// Represents a single disassembled instruction. class DisassembledInstruction { /// The address of the instruction. Treated as a hex value if prefixed with - /// '0x', or as a decimal value otherwise. + /// `0x`, or as a decimal value otherwise. final String address; /// The column within the line that corresponds to this instruction, if any. @@ -1624,7 +1695,7 @@ class DisassembledInstruction { /// implementation-defined format. final String instruction; - /// Optional raw bytes representing the instruction and its operands, in an + /// Raw bytes representing the instruction and its operands, in an /// implementation-defined format. final String? instructionBytes; @@ -1717,25 +1788,25 @@ class DisassembledInstruction { }; } -/// Arguments for 'disconnect' request. +/// Arguments for `disconnect` request. class DisconnectArguments extends RequestArguments { - /// A value of true indicates that this 'disconnect' request is part of a + /// A value of true indicates that this `disconnect` request is part of a /// restart sequence. final bool? restart; /// Indicates whether the debuggee should stay suspended when the debugger is /// disconnected. /// If unspecified, the debuggee should resume execution. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportSuspendDebuggee' is true. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportSuspendDebuggee` is true. final bool? suspendDebuggee; /// Indicates whether the debuggee should be terminated when the debugger is /// disconnected. /// If unspecified, the debug adapter is free to do whatever it thinks is /// best. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportTerminateDebuggee' is true. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportTerminateDebuggee` is true. final bool? terminateDebuggee; static DisconnectArguments fromJson(Map obj) => @@ -1775,7 +1846,7 @@ class DisconnectArguments extends RequestArguments { }; } -/// Response to 'disconnect' request. This is just an acknowledgement, so no +/// Response to `disconnect` request. This is just an acknowledgement, so no /// body field is required. class DisconnectResponse extends Response { static DisconnectResponse fromJson(Map obj) => @@ -1812,7 +1883,7 @@ class DisconnectResponse extends Response { }; } -/// On error (whenever 'success' is false), the body can provide more details. +/// On error (whenever `success` is false), the body can provide more details. class ErrorResponse extends Response { static ErrorResponse fromJson(Map obj) => ErrorResponse.fromMap(obj); @@ -1851,17 +1922,17 @@ class ErrorResponse extends Response { }; } -/// Arguments for 'evaluate' request. +/// Arguments for `evaluate` request. class EvaluateArguments extends RequestArguments { - /// The context in which the evaluate request is run. + /// The context in which the evaluate request is used. final String? context; /// The expression to evaluate. final String expression; - /// Specifies details on how to format the Evaluate result. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportsValueFormattingOptions' is true. + /// Specifies details on how to format the result. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsValueFormattingOptions` is true. final ValueFormat? format; /// Evaluate the expression in the scope of this stack frame. If not @@ -1913,7 +1984,7 @@ class EvaluateArguments extends RequestArguments { }; } -/// Response to 'evaluate' request. +/// Response to `evaluate` request. class EvaluateResponse extends Response { static EvaluateResponse fromJson(Map obj) => EvaluateResponse.fromMap(obj); @@ -2005,27 +2076,26 @@ class Event extends ProtocolMessage { /// userUnhandled: breaks if the exception is not handled by user code. typedef ExceptionBreakMode = String; -/// An ExceptionBreakpointsFilter is shown in the UI as an filter option for +/// An `ExceptionBreakpointsFilter` is shown in the UI as an filter option for /// configuring how exceptions are dealt with. class ExceptionBreakpointsFilter { - /// An optional help text providing information about the condition. This - /// string is shown as the placeholder text for a text box and must be - /// translated. + /// A help text providing information about the condition. This string is + /// shown as the placeholder text for a text box and can be translated. final String? conditionDescription; - /// Initial value of the filter option. If not specified a value 'false' is + /// Initial value of the filter option. If not specified a value false is /// assumed. final bool? defaultValue; - /// An optional help text providing additional information about the exception - /// filter. This string is typically shown as a hover and must be translated. + /// A help text providing additional information about the exception filter. + /// This string is typically shown as a hover and can be translated. final String? description; /// The internal ID of the filter option. This value is passed to the - /// 'setExceptionBreakpoints' request. + /// `setExceptionBreakpoints` request. final String filter; - /// The name of the filter option. This will be shown in the UI. + /// The name of the filter option. This is shown in the UI. final String label; /// Controls whether a condition can be specified for this filter option. If @@ -2090,8 +2160,8 @@ class ExceptionBreakpointsFilter { /// Detailed information about an exception that has occurred. class ExceptionDetails { - /// Optional expression that can be evaluated in the current scope to obtain - /// the exception object. + /// An expression that can be evaluated in the current scope to obtain the + /// exception object. final String? evaluateName; /// Fully-qualified type name of the exception object. @@ -2169,15 +2239,15 @@ class ExceptionDetails { }; } -/// An ExceptionFilterOptions is used to specify an exception filter together -/// with a condition for the setExceptionsFilter request. +/// An `ExceptionFilterOptions` is used to specify an exception filter together +/// with a condition for the `setExceptionBreakpoints` request. class ExceptionFilterOptions { - /// An optional expression for conditional exceptions. - /// The exception will break into the debugger if the result of the condition - /// is true. + /// An expression for conditional exceptions. + /// The exception breaks into the debugger if the result of the condition is + /// true. final String? condition; - /// ID of an exception filter returned by the 'exceptionBreakpointFilters' + /// ID of an exception filter returned by the `exceptionBreakpointFilters` /// capability. final String filterId; @@ -2212,7 +2282,7 @@ class ExceptionFilterOptions { }; } -/// Arguments for 'exceptionInfo' request. +/// Arguments for `exceptionInfo` request. class ExceptionInfoArguments extends RequestArguments { /// Thread for which exception information should be retrieved. final int threadId; @@ -2242,7 +2312,7 @@ class ExceptionInfoArguments extends RequestArguments { }; } -/// Response to 'exceptionInfo' request. +/// Response to `exceptionInfo` request. class ExceptionInfoResponse extends Response { static ExceptionInfoResponse fromJson(Map obj) => ExceptionInfoResponse.fromMap(obj); @@ -2281,12 +2351,12 @@ class ExceptionInfoResponse extends Response { }; } -/// An ExceptionOptions assigns configuration options to a set of exceptions. +/// An `ExceptionOptions` assigns configuration options to a set of exceptions. class ExceptionOptions { /// Condition when a thrown exception should result in a break. final ExceptionBreakMode breakMode; - /// A path that selects a single or multiple exceptions in a tree. If 'path' + /// A path that selects a single or multiple exceptions in a tree. If `path` /// is missing, the whole tree is selected. /// By convention the first segment of the path is a category that is used to /// group exceptions in the UI. @@ -2327,13 +2397,13 @@ class ExceptionOptions { }; } -/// An ExceptionPathSegment represents a segment in a path that is used to match -/// leafs or nodes in a tree 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. +/// if `negate` is false or missing, or it matches anything except the names +/// provided if `negate` is true. class ExceptionPathSegment { - /// Depending on the value of 'negate' the names that should match or not + /// Depending on the value of `negate` the names that should match or not /// match. final List names; @@ -2373,18 +2443,17 @@ class ExceptionPathSegment { }; } -/// Properties of a breakpoint passed to the setFunctionBreakpoints request. +/// Properties of a breakpoint passed to the `setFunctionBreakpoints` request. class FunctionBreakpoint { - /// An optional expression for conditional breakpoints. - /// It is only honored by a debug adapter if the capability - /// 'supportsConditionalBreakpoints' is true. + /// An expression for conditional breakpoints. + /// It is only honored by a debug adapter if the corresponding capability + /// `supportsConditionalBreakpoints` is true. final String? condition; - /// An optional expression that controls how many hits of the breakpoint are - /// ignored. - /// The backend is expected to interpret the expression as needed. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportsHitConditionalBreakpoints' is true. + /// An expression that controls how many hits of the breakpoint are ignored. + /// The debug adapter is expected to interpret the expression as needed. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsHitConditionalBreakpoints` is true. final String? hitCondition; /// The name of the function. @@ -2427,7 +2496,7 @@ class FunctionBreakpoint { }; } -/// Arguments for 'goto' request. +/// Arguments for `goto` request. class GotoArguments extends RequestArguments { /// The location where the debuggee will continue to run. final int targetId; @@ -2466,7 +2535,7 @@ class GotoArguments extends RequestArguments { }; } -/// Response to 'goto' request. This is just an acknowledgement, so no body +/// Response to `goto` request. This is just an acknowledgement, so no body /// field is required. class GotoResponse extends Response { static GotoResponse fromJson(Map obj) => @@ -2503,24 +2572,24 @@ class GotoResponse extends Response { }; } -/// 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. +/// 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. class GotoTarget { - /// An optional column of the goto target. + /// The column of the goto target. final int? column; - /// An optional end column of the range covered by the goto target. + /// The end column of the range covered by the goto target. final int? endColumn; - /// An optional end line of the range covered by the goto target. + /// The end line of the range covered by the goto target. final int? endLine; - /// Unique identifier for a goto target. This is used in the goto request. + /// Unique identifier for a goto target. This is used in the `goto` request. final int id; - /// Optional memory reference for the instruction pointer value represented by - /// this target. + /// A memory reference for the instruction pointer value represented by this + /// target. final String? instructionPointerReference; /// The name of the goto target (shown in the UI). @@ -2592,9 +2661,11 @@ class GotoTarget { }; } -/// Arguments for 'gotoTargets' request. +/// Arguments for `gotoTargets` request. class GotoTargetsArguments extends RequestArguments { - /// An optional column location for which the goto targets are determined. + /// The position within `line` for which the goto targets are determined. It + /// is measured in UTF-16 code units and the client capability + /// `columnsStartAt1` determines whether it is 0- or 1-based. final int? column; /// The line location for which the goto targets are determined. @@ -2640,7 +2711,7 @@ class GotoTargetsArguments extends RequestArguments { }; } -/// Response to 'gotoTargets' request. +/// Response to `gotoTargets` request. class GotoTargetsResponse extends Response { static GotoTargetsResponse fromJson(Map obj) => GotoTargetsResponse.fromMap(obj); @@ -2679,15 +2750,15 @@ class GotoTargetsResponse extends Response { }; } -/// Arguments for 'initialize' request. +/// Arguments for `initialize` request. class InitializeRequestArguments extends RequestArguments { /// The ID of the debug adapter. final String adapterID; - /// The ID of the (frontend) client using this adapter. + /// The ID of the client using this adapter. final String? clientID; - /// The human readable name of the (frontend) client using this adapter. + /// The human-readable name of the client using this adapter. final String? clientName; /// If true all column numbers are 1-based (default). @@ -2696,30 +2767,39 @@ class InitializeRequestArguments extends RequestArguments { /// If true all line numbers are 1-based (default). final bool? linesStartAt1; - /// The ISO-639 locale of the (frontend) client using this adapter, e.g. en-US - /// or de-CH. + /// The ISO-639 locale of the client using this adapter, e.g. en-US or de-CH. final String? locale; - /// Determines in what format paths are specified. The default is 'path', + /// Determines in what format paths are specified. The default is `path`, /// which is the native format. final String? pathFormat; - /// Client supports the invalidated event. + /// Client supports the `argsCanBeInterpretedByShell` attribute on the + /// `runInTerminal` request. + final bool? supportsArgsCanBeInterpretedByShell; + + /// Client supports the `invalidated` event. final bool? supportsInvalidatedEvent; + /// Client supports the `memory` event. + final bool? supportsMemoryEvent; + /// Client supports memory references. final bool? supportsMemoryReferences; /// Client supports progress reporting. final bool? supportsProgressReporting; - /// Client supports the runInTerminal request. + /// Client supports the `runInTerminal` request. final bool? supportsRunInTerminalRequest; + /// Client supports the `startDebugging` request. + final bool? supportsStartDebuggingRequest; + /// Client supports the paging of variables. final bool? supportsVariablePaging; - /// Client supports the optional type attribute for variables. + /// Client supports the `type` attribute for variables. final bool? supportsVariableType; static InitializeRequestArguments fromJson(Map obj) => @@ -2733,10 +2813,13 @@ class InitializeRequestArguments extends RequestArguments { this.linesStartAt1, this.locale, this.pathFormat, + this.supportsArgsCanBeInterpretedByShell, this.supportsInvalidatedEvent, + this.supportsMemoryEvent, this.supportsMemoryReferences, this.supportsProgressReporting, this.supportsRunInTerminalRequest, + this.supportsStartDebuggingRequest, this.supportsVariablePaging, this.supportsVariableType, }); @@ -2749,11 +2832,16 @@ class InitializeRequestArguments extends RequestArguments { linesStartAt1 = obj['linesStartAt1'] as bool?, locale = obj['locale'] as String?, pathFormat = obj['pathFormat'] as String?, + supportsArgsCanBeInterpretedByShell = + obj['supportsArgsCanBeInterpretedByShell'] as bool?, supportsInvalidatedEvent = obj['supportsInvalidatedEvent'] as bool?, + supportsMemoryEvent = obj['supportsMemoryEvent'] as bool?, supportsMemoryReferences = obj['supportsMemoryReferences'] as bool?, supportsProgressReporting = obj['supportsProgressReporting'] as bool?, supportsRunInTerminalRequest = obj['supportsRunInTerminalRequest'] as bool?, + supportsStartDebuggingRequest = + obj['supportsStartDebuggingRequest'] as bool?, supportsVariablePaging = obj['supportsVariablePaging'] as bool?, supportsVariableType = obj['supportsVariableType'] as bool?; @@ -2782,9 +2870,15 @@ class InitializeRequestArguments extends RequestArguments { if (obj['pathFormat'] is! String?) { return false; } + if (obj['supportsArgsCanBeInterpretedByShell'] is! bool?) { + return false; + } if (obj['supportsInvalidatedEvent'] is! bool?) { return false; } + if (obj['supportsMemoryEvent'] is! bool?) { + return false; + } if (obj['supportsMemoryReferences'] is! bool?) { return false; } @@ -2794,6 +2888,9 @@ class InitializeRequestArguments extends RequestArguments { if (obj['supportsRunInTerminalRequest'] is! bool?) { return false; } + if (obj['supportsStartDebuggingRequest'] is! bool?) { + return false; + } if (obj['supportsVariablePaging'] is! bool?) { return false; } @@ -2811,14 +2908,21 @@ class InitializeRequestArguments extends RequestArguments { if (linesStartAt1 != null) 'linesStartAt1': linesStartAt1, if (locale != null) 'locale': locale, if (pathFormat != null) 'pathFormat': pathFormat, + if (supportsArgsCanBeInterpretedByShell != null) + 'supportsArgsCanBeInterpretedByShell': + supportsArgsCanBeInterpretedByShell, if (supportsInvalidatedEvent != null) 'supportsInvalidatedEvent': supportsInvalidatedEvent, + if (supportsMemoryEvent != null) + 'supportsMemoryEvent': supportsMemoryEvent, if (supportsMemoryReferences != null) 'supportsMemoryReferences': supportsMemoryReferences, if (supportsProgressReporting != null) 'supportsProgressReporting': supportsProgressReporting, if (supportsRunInTerminalRequest != null) 'supportsRunInTerminalRequest': supportsRunInTerminalRequest, + if (supportsStartDebuggingRequest != null) + 'supportsStartDebuggingRequest': supportsStartDebuggingRequest, if (supportsVariablePaging != null) 'supportsVariablePaging': supportsVariablePaging, if (supportsVariableType != null) @@ -2826,7 +2930,7 @@ class InitializeRequestArguments extends RequestArguments { }; } -/// Response to 'initialize' request. +/// Response to `initialize` request. class InitializeResponse extends Response { static InitializeResponse fromJson(Map obj) => InitializeResponse.fromMap(obj); @@ -2865,26 +2969,26 @@ class InitializeResponse extends Response { }; } -/// Properties of a breakpoint passed to the setInstructionBreakpoints request +/// Properties of a breakpoint passed to the `setInstructionBreakpoints` request class InstructionBreakpoint { - /// An optional expression for conditional breakpoints. - /// It is only honored by a debug adapter if the capability - /// 'supportsConditionalBreakpoints' is true. + /// An expression for conditional breakpoints. + /// It is only honored by a debug adapter if the corresponding capability + /// `supportsConditionalBreakpoints` is true. final String? condition; - /// An optional expression that controls how many hits of the breakpoint are - /// ignored. - /// The backend is expected to interpret the expression as needed. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportsHitConditionalBreakpoints' is true. + /// An expression that controls how many hits of the breakpoint are ignored. + /// The debug adapter is expected to interpret the expression as needed. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsHitConditionalBreakpoints` is true. final String? hitCondition; /// The instruction reference of the breakpoint. /// This should be a memory or instruction pointer reference from an - /// EvaluateResponse, Variable, StackFrame, GotoTarget, or Breakpoint. + /// `EvaluateResponse`, `Variable`, `StackFrame`, `GotoTarget`, or + /// `Breakpoint`. final String instructionReference; - /// An optional offset from the instruction reference. + /// The offset from the instruction reference. /// This can be negative. final int? offset; @@ -2931,19 +3035,19 @@ class InstructionBreakpoint { }; } -/// Logical areas that can be invalidated by the 'invalidated' event. +/// Logical areas that can be invalidated by the `invalidated` event. typedef InvalidatedAreas = String; -/// Arguments for 'launch' request. Additional attributes are implementation +/// Arguments for `launch` request. Additional attributes are implementation /// specific. class LaunchRequestArguments extends RequestArguments { - /// Optional data from the previous, restarted session. - /// The data is sent as the 'restart' attribute of the 'terminated' event. + /// Arbitrary data from the previous, restarted session. + /// The data is sent as the `restart` attribute of the `terminated` event. /// The client should leave the data intact. final Object? restart; - /// If noDebug is true the launch request should launch the program without - /// enabling debugging. + /// If true, the launch request should launch the program without enabling + /// debugging. final bool? noDebug; static LaunchRequestArguments fromJson(Map obj) => @@ -2974,7 +3078,7 @@ class LaunchRequestArguments extends RequestArguments { }; } -/// Response to 'launch' request. This is just an acknowledgement, so no body +/// Response to `launch` request. This is just an acknowledgement, so no body /// field is required. class LaunchResponse extends Response { static LaunchResponse fromJson(Map obj) => @@ -3011,7 +3115,7 @@ class LaunchResponse extends Response { }; } -/// Arguments for 'loadedSources' request. +/// Arguments for `loadedSources` request. class LoadedSourcesArguments extends RequestArguments { static LoadedSourcesArguments fromJson(Map obj) => LoadedSourcesArguments.fromMap(obj); @@ -3030,7 +3134,7 @@ class LoadedSourcesArguments extends RequestArguments { Map toJson() => {}; } -/// Response to 'loadedSources' request. +/// Response to `loadedSources` request. class LoadedSourcesResponse extends Response { static LoadedSourcesResponse fromJson(Map obj) => LoadedSourcesResponse.fromMap(obj); @@ -3072,12 +3176,16 @@ class LoadedSourcesResponse extends Response { /// A structured message object. Used to return errors from requests. class Message { /// A format string for the message. Embedded variables have the form - /// '{name}'. + /// `{name}`. /// If variable name starts with an underscore character, the variable does /// not contain user data (PII) and can be safely used for telemetry purposes. final String format; - /// Unique identifier for the message. + /// Unique (within a debug adapter implementation) identifier for the message. + /// The purpose of these error IDs is to help extension authors that have the + /// requirement that every user visible error message needs a corresponding + /// error number, so that users or customer support can find information about + /// the specific error more easily. final int id; /// If true send to telemetry. @@ -3086,12 +3194,10 @@ class Message { /// If true show user. final bool? showUser; - /// An optional url where additional information about this message can be - /// found. + /// A url where additional information about this message can be found. final String? url; - /// An optional label that is presented to the user as the UI for opening the - /// url. + /// A label that is presented to the user as the UI for opening the url. final String? urlLabel; /// An object used as a dictionary for looking up the variables in the format @@ -3159,23 +3265,22 @@ class Message { } /// 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. +/// The `id` attribute identifies a module in the modules view and is used in a +/// `module` event for identifying a module for adding, updating or deleting. +/// The `name` attribute is used to minimally render the module in the UI. /// -/// Additional attributes can be added to the module. They will show up in the -/// module View if they have a corresponding ColumnDescriptor. +/// Additional attributes can be added to the module. They show up in the module +/// view if they have a corresponding `ColumnDescriptor`. /// /// To avoid an unnecessary proliferation of additional attributes with similar -/// semantics but different names -/// we recommend to re-use attributes from the 'recommended' list below first, -/// and only introduce new attributes if nothing appropriate could be found. +/// semantics but different names, we recommend to re-use attributes from the +/// 'recommended' list below first, and only introduce new attributes if nothing +/// appropriate could be found. class Module { /// Address range covered by this module. final String? addressRange; - /// Module created or modified. + /// Module created or modified, encoded as a RFC 3339 timestamp. final String? dateTimeStamp; /// Unique identifier for the module. @@ -3191,9 +3296,6 @@ class Module { /// A name of the module. final String name; - /// optional but recommended attributes. - /// always try to use these first before introducing additional attributes. - /// /// Logical full path to the module. The exact definition is implementation /// defined, but usually this would be a full path to the on-disk file for the /// module. @@ -3203,8 +3305,8 @@ class Module { /// implementation defined. final String? symbolFilePath; - /// User understandable description of if symbols were found for the module - /// (ex: 'Symbols Loaded', 'Symbols not found', etc. + /// User-understandable description of if symbols were found for the module + /// (ex: 'Symbols Loaded', 'Symbols not found', etc.) final String? symbolStatus; /// Version of Module. @@ -3290,10 +3392,10 @@ class Module { }; } -/// Arguments for 'modules' request. +/// Arguments for `modules` request. class ModulesArguments extends RequestArguments { - /// The number of modules to return. If moduleCount is not specified or 0, all - /// modules are returned. + /// The number of modules to return. If `moduleCount` is not specified or 0, + /// all modules are returned. final int? moduleCount; /// The index of the first module to return; if omitted modules start at 0. @@ -3330,7 +3432,7 @@ class ModulesArguments extends RequestArguments { }; } -/// Response to 'modules' request. +/// Response to `modules` request. class ModulesResponse extends Response { static ModulesResponse fromJson(Map obj) => ModulesResponse.fromMap(obj); @@ -3369,48 +3471,17 @@ class ModulesResponse extends Response { }; } -/// 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. -class ModulesViewDescriptor { - final List columns; - - static ModulesViewDescriptor fromJson(Map obj) => - ModulesViewDescriptor.fromMap(obj); - - ModulesViewDescriptor({ - required this.columns, - }); - - ModulesViewDescriptor.fromMap(Map obj) - : columns = (obj['columns'] as List) - .map((item) => - ColumnDescriptor.fromJson(item as Map)) - .toList(); - - static bool canParse(Object? obj) { - if (obj is! Map) { - return false; - } - if ((obj['columns'] is! List || - (obj['columns'].any((item) => !ColumnDescriptor.canParse(item))))) { - return false; - } - return true; - } - - Map toJson() => { - 'columns': columns, - }; -} - -/// Arguments for 'next' request. +/// Arguments for `next` request. class NextArguments extends RequestArguments { - /// Optional granularity to step. If no granularity is specified, a - /// granularity of 'statement' is assumed. + /// Stepping granularity. If no granularity is specified, a granularity of + /// `statement` is assumed. final SteppingGranularity? granularity; - /// Execute 'next' for this thread. + /// If this flag is true, all other suspended threads are not resumed. + final bool? singleThread; + + /// Specifies the thread for which to resume execution for one step (of the + /// given granularity). final int threadId; static NextArguments fromJson(Map obj) => @@ -3418,11 +3489,13 @@ class NextArguments extends RequestArguments { NextArguments({ this.granularity, + this.singleThread, required this.threadId, }); NextArguments.fromMap(Map obj) : granularity = obj['granularity'] as SteppingGranularity?, + singleThread = obj['singleThread'] as bool?, threadId = obj['threadId'] as int; static bool canParse(Object? obj) { @@ -3432,6 +3505,9 @@ class NextArguments extends RequestArguments { if (obj['granularity'] is! SteppingGranularity?) { return false; } + if (obj['singleThread'] is! bool?) { + return false; + } if (obj['threadId'] is! int) { return false; } @@ -3440,11 +3516,12 @@ class NextArguments extends RequestArguments { Map toJson() => { if (granularity != null) 'granularity': granularity, + if (singleThread != null) 'singleThread': singleThread, 'threadId': threadId, }; } -/// Response to 'next' request. This is just an acknowledgement, so no body +/// Response to `next` request. This is just an acknowledgement, so no body /// field is required. class NextResponse extends Response { static NextResponse fromJson(Map obj) => @@ -3481,7 +3558,7 @@ class NextResponse extends Response { }; } -/// Arguments for 'pause' request. +/// Arguments for `pause` request. class PauseArguments extends RequestArguments { /// Pause execution for this thread. final int threadId; @@ -3511,7 +3588,7 @@ class PauseArguments extends RequestArguments { }; } -/// Response to 'pause' request. This is just an acknowledgement, so no body +/// Response to `pause` request. This is just an acknowledgement, so no body /// field is required. class PauseResponse extends Response { static PauseResponse fromJson(Map obj) => @@ -3550,8 +3627,13 @@ class PauseResponse extends Response { /// Base class of requests, responses, and events. class ProtocolMessage { - /// Sequence number (also known as message ID). For protocol messages of type - /// 'request' this ID can be used to cancel the request. + /// Sequence number of the message (also known as message ID). The `seq` for + /// the first message sent by a client or debug adapter is 1, and for each + /// subsequent message is 1 greater than the previous message sent by that + /// actor. `seq` can be used to order requests, responses, and events, and to + /// associate requests with their corresponding responses. For protocol + /// messages of type `request` the sequence number can be used to cancel the + /// request. final int seq; /// Message type. @@ -3588,7 +3670,7 @@ class ProtocolMessage { }; } -/// Arguments for 'readMemory' request. +/// Arguments for `readMemory` request. class ReadMemoryArguments extends RequestArguments { /// Number of bytes to read at the specified location and offset. final int count; @@ -3596,8 +3678,8 @@ class ReadMemoryArguments extends RequestArguments { /// Memory reference to the base location from which data should be read. final String memoryReference; - /// Optional offset (in bytes) to be applied to the reference location before - /// reading data. Can be negative. + /// Offset (in bytes) to be applied to the reference location before reading + /// data. Can be negative. final int? offset; static ReadMemoryArguments fromJson(Map obj) => @@ -3637,7 +3719,7 @@ class ReadMemoryArguments extends RequestArguments { }; } -/// Response to 'readMemory' request. +/// Response to `readMemory` request. class ReadMemoryResponse extends Response { static ReadMemoryResponse fromJson(Map obj) => ReadMemoryResponse.fromMap(obj); @@ -3723,16 +3805,16 @@ class Request extends ProtocolMessage { /// Response for a request. class Response extends ProtocolMessage { - /// Contains request result if success is true and optional error details if - /// success is false. + /// Contains request result if success is true and error details if success is + /// false. final Object? body; /// The command requested. final String command; - /// Contains the raw error in short form if 'success' is false. - /// This raw error might be interpreted by the frontend and is not shown in - /// the UI. + /// Contains the raw error in short form if `success` is false. + /// This raw error might be interpreted by the client and is not shown in the + /// UI. /// Some predefined values exist. final String? message; @@ -3740,11 +3822,11 @@ class Response extends ProtocolMessage { final int requestSeq; /// Outcome of the request. - /// If true, the request was successful and the 'body' attribute may contain + /// If true, the request was successful and the `body` attribute may contain /// the result of the request. - /// If the value is false, the attribute 'message' contains the error in short - /// form and the 'body' may contain additional information (see - /// 'ErrorResponse.body.error'). + /// If the value is false, the attribute `message` contains the error in short + /// form and the `body` may contain additional information (see + /// `ErrorResponse.body.error`). final bool success; static Response fromJson(Map obj) => Response.fromMap(obj); @@ -3802,9 +3884,9 @@ class Response extends ProtocolMessage { }; } -/// Arguments for 'restart' request. +/// Arguments for `restart` request. class RestartArguments extends RequestArguments { - /// The latest version of the 'launch' or 'attach' configuration. + /// The latest version of the `launch` or `attach` configuration. final Either2? arguments; static RestartArguments fromJson(Map obj) => @@ -3842,9 +3924,11 @@ class RestartArguments extends RequestArguments { }; } -/// Arguments for 'restartFrame' request. +/// Arguments for `restartFrame` request. class RestartFrameArguments extends RequestArguments { - /// Restart this stackframe. + /// Restart the stack frame identified by `frameId`. The `frameId` must have + /// been obtained in the current suspended state. See 'Lifetime of Object + /// References' in the Overview section for details. final int frameId; static RestartFrameArguments fromJson(Map obj) => @@ -3872,7 +3956,7 @@ class RestartFrameArguments extends RequestArguments { }; } -/// Response to 'restartFrame' request. This is just an acknowledgement, so no +/// Response to `restartFrame` request. This is just an acknowledgement, so no /// body field is required. class RestartFrameResponse extends Response { static RestartFrameResponse fromJson(Map obj) => @@ -3909,7 +3993,7 @@ class RestartFrameResponse extends Response { }; } -/// Response to 'restart' request. This is just an acknowledgement, so no body +/// Response to `restart` request. This is just an acknowledgement, so no body /// field is required. class RestartResponse extends Response { static RestartResponse fromJson(Map obj) => @@ -3946,25 +4030,36 @@ class RestartResponse extends Response { }; } -/// Arguments for 'reverseContinue' request. +/// Arguments for `reverseContinue` request. class ReverseContinueArguments extends RequestArguments { - /// Execute 'reverseContinue' for this thread. + /// If this flag is true, backward execution is resumed only for the thread + /// with given `threadId`. + final bool? singleThread; + + /// Specifies the active thread. If the debug adapter supports single thread + /// execution (see `supportsSingleThreadExecutionRequests`) and the + /// `singleThread` argument is true, only the thread with this ID is resumed. final int threadId; static ReverseContinueArguments fromJson(Map obj) => ReverseContinueArguments.fromMap(obj); ReverseContinueArguments({ + this.singleThread, required this.threadId, }); ReverseContinueArguments.fromMap(Map obj) - : threadId = obj['threadId'] as int; + : singleThread = obj['singleThread'] as bool?, + threadId = obj['threadId'] as int; static bool canParse(Object? obj) { if (obj is! Map) { return false; } + if (obj['singleThread'] is! bool?) { + return false; + } if (obj['threadId'] is! int) { return false; } @@ -3972,11 +4067,12 @@ class ReverseContinueArguments extends RequestArguments { } Map toJson() => { + if (singleThread != null) 'singleThread': singleThread, 'threadId': threadId, }; } -/// Response to 'reverseContinue' request. This is just an acknowledgement, so +/// Response to `reverseContinue` request. This is just an acknowledgement, so /// no body field is required. class ReverseContinueResponse extends Response { static ReverseContinueResponse fromJson(Map obj) => @@ -4014,11 +4110,19 @@ class ReverseContinueResponse extends Response { }; } -/// Arguments for 'runInTerminal' request. +/// Arguments for `runInTerminal` request. class RunInTerminalRequestArguments extends RequestArguments { /// List of arguments. The first argument is the command to run. final List args; + /// This property should only be set if the corresponding capability + /// `supportsArgsCanBeInterpretedByShell` is true. If the client uses an + /// intermediary shell to launch the application, then the client must not + /// attempt to escape characters with special meanings for the shell. The user + /// is fully responsible for escaping as needed and that arguments using + /// special characters may not be portable across shells. + final bool? argsCanBeInterpretedByShell; + /// Working directory for the command. For non-empty, valid paths this /// typically results in execution of a change directory command. final String cwd; @@ -4027,10 +4131,11 @@ class RunInTerminalRequestArguments extends RequestArguments { /// environment. final Map? env; - /// What kind of terminal to launch. + /// What kind of terminal to launch. Defaults to `integrated` if not + /// specified. final String? kind; - /// Optional title of the terminal. + /// Title of the terminal. final String? title; static RunInTerminalRequestArguments fromJson(Map obj) => @@ -4038,6 +4143,7 @@ class RunInTerminalRequestArguments extends RequestArguments { RunInTerminalRequestArguments({ required this.args, + this.argsCanBeInterpretedByShell, required this.cwd, this.env, this.kind, @@ -4046,6 +4152,8 @@ class RunInTerminalRequestArguments extends RequestArguments { RunInTerminalRequestArguments.fromMap(Map obj) : args = (obj['args'] as List).map((item) => item as String).toList(), + argsCanBeInterpretedByShell = + obj['argsCanBeInterpretedByShell'] as bool?, cwd = obj['cwd'] as String, env = obj['env'] as Map?, kind = obj['kind'] as String?, @@ -4059,6 +4167,9 @@ class RunInTerminalRequestArguments extends RequestArguments { (obj['args'].any((item) => item is! String)))) { return false; } + if (obj['argsCanBeInterpretedByShell'] is! bool?) { + return false; + } if (obj['cwd'] is! String) { return false; } @@ -4076,6 +4187,8 @@ class RunInTerminalRequestArguments extends RequestArguments { Map toJson() => { 'args': args, + if (argsCanBeInterpretedByShell != null) + 'argsCanBeInterpretedByShell': argsCanBeInterpretedByShell, 'cwd': cwd, if (env != null) 'env': env, if (kind != null) 'kind': kind, @@ -4083,7 +4196,7 @@ class RunInTerminalRequestArguments extends RequestArguments { }; } -/// Response to 'runInTerminal' request. +/// Response to `runInTerminal` request. class RunInTerminalResponse extends Response { static RunInTerminalResponse fromJson(Map obj) => RunInTerminalResponse.fromMap(obj); @@ -4122,16 +4235,20 @@ class RunInTerminalResponse extends Response { }; } -/// A Scope is a named container for variables. Optionally a scope can map to a -/// source or a range within a source. +/// A `Scope` is a named container for variables. Optionally a scope can map to +/// a source or a range within a source. class Scope { - /// Optional start column of the range covered by this scope. + /// Start position of the range covered by the scope. It is measured in UTF-16 + /// code units and the client capability `columnsStartAt1` determines whether + /// it is 0- or 1-based. final int? column; - /// Optional end column of the range covered by this scope. + /// End position of the range covered by the scope. It is measured in UTF-16 + /// code units and the client capability `columnsStartAt1` determines whether + /// it is 0- or 1-based. final int? endColumn; - /// Optional end line of the range covered by this scope. + /// The end line of the range covered by this scope. final int? endLine; /// If true, the number of variables in this scope is large or expensive to @@ -4139,11 +4256,11 @@ class Scope { final bool expensive; /// The number of indexed variables in this scope. - /// The client can use this optional information to present the variables in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the variables in a paged UI + /// and fetch them in chunks. final int? indexedVariables; - /// Optional start line of the range covered by this scope. + /// The start line of the range covered by this scope. final int? line; /// Name of the scope such as 'Arguments', 'Locals', or 'Registers'. This @@ -4151,19 +4268,21 @@ class Scope { final String name; /// The number of named variables in this scope. - /// The client can use this optional information to present the variables in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the variables in a paged UI + /// and fetch them in chunks. final int? namedVariables; - /// An optional hint for how to present this scope in the UI. If this - /// attribute is missing, the scope is shown with a generic UI. + /// A hint for how to present this scope in the UI. If this attribute is + /// missing, the scope is shown with a generic UI. final String? presentationHint; - /// Optional source for this scope. + /// The source for this scope. final Source? source; /// The variables of this scope can be retrieved by passing the value of - /// variablesReference to the VariablesRequest. + /// `variablesReference` to the `variables` request as long as execution + /// remains suspended. See 'Lifetime of Object References' in the Overview + /// section for details. final int variablesReference; static Scope fromJson(Map obj) => Scope.fromMap(obj); @@ -4252,9 +4371,11 @@ class Scope { }; } -/// Arguments for 'scopes' request. +/// Arguments for `scopes` request. class ScopesArguments extends RequestArguments { - /// Retrieve the scopes for this stackframe. + /// Retrieve the scopes for the stack frame identified by `frameId`. The + /// `frameId` must have been obtained in the current suspended state. See + /// 'Lifetime of Object References' in the Overview section for details. final int frameId; static ScopesArguments fromJson(Map obj) => @@ -4282,7 +4403,7 @@ class ScopesArguments extends RequestArguments { }; } -/// Response to 'scopes' request. +/// Response to `scopes` request. class ScopesResponse extends Response { static ScopesResponse fromJson(Map obj) => ScopesResponse.fromMap(obj); @@ -4321,7 +4442,7 @@ class ScopesResponse extends Response { }; } -/// Arguments for 'setBreakpoints' request. +/// Arguments for `setBreakpoints` request. class SetBreakpointsArguments extends RequestArguments { /// The code locations of the breakpoints. final List? breakpoints; @@ -4329,8 +4450,8 @@ class SetBreakpointsArguments extends RequestArguments { /// Deprecated: The code locations of the breakpoints. final List? lines; - /// The source location of the breakpoints; either 'source.path' or - /// 'source.reference' must be specified. + /// The source location of the breakpoints; either `source.path` or + /// `source.sourceReference` must be specified. final Source source; /// A value of true indicates that the underlying source has been modified @@ -4384,13 +4505,13 @@ class SetBreakpointsArguments extends RequestArguments { }; } -/// Response to 'setBreakpoints' request. +/// 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. +/// `breakpoints` +/// (or the deprecated `lines`) array in the arguments. class SetBreakpointsResponse extends Response { static SetBreakpointsResponse fromJson(Map obj) => SetBreakpointsResponse.fromMap(obj); @@ -4429,7 +4550,7 @@ class SetBreakpointsResponse extends Response { }; } -/// Arguments for 'setDataBreakpoints' request. +/// Arguments for `setDataBreakpoints` request. class SetDataBreakpointsArguments extends RequestArguments { /// The contents of this array replaces all existing data breakpoints. An /// empty array clears all data breakpoints. @@ -4464,7 +4585,7 @@ class SetDataBreakpointsArguments extends RequestArguments { }; } -/// Response to 'setDataBreakpoints' request. +/// Response to `setDataBreakpoints` request. /// Returned is information about each breakpoint created by this request. class SetDataBreakpointsResponse extends Response { static SetDataBreakpointsResponse fromJson(Map obj) => @@ -4505,23 +4626,23 @@ class SetDataBreakpointsResponse extends Response { }; } -/// Arguments for 'setExceptionBreakpoints' request. +/// Arguments for `setExceptionBreakpoints` request. class SetExceptionBreakpointsArguments extends RequestArguments { /// Configuration options for selected exceptions. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportsExceptionOptions' is true. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsExceptionOptions` is true. final List? exceptionOptions; /// Set of exception filters and their options. The set of all possible - /// exception filters is defined by the 'exceptionBreakpointFilters' + /// exception filters is defined by the `exceptionBreakpointFilters` /// capability. This attribute is only honored by a debug adapter if the - /// capability 'supportsExceptionFilterOptions' is true. The 'filter' and - /// 'filterOptions' sets are additive. + /// corresponding capability `supportsExceptionFilterOptions` is true. The + /// `filter` and `filterOptions` sets are additive. final List? filterOptions; /// Set of exception filters specified by their ID. The set of all possible - /// exception filters is defined by the 'exceptionBreakpointFilters' - /// capability. The 'filter' and 'filterOptions' sets are additive. + /// exception filters is defined by the `exceptionBreakpointFilters` + /// capability. The `filter` and `filterOptions` sets are additive. final List filters; static SetExceptionBreakpointsArguments fromJson(Map obj) => @@ -4573,22 +4694,22 @@ class SetExceptionBreakpointsArguments extends RequestArguments { }; } -/// Response to 'setExceptionBreakpoints' request. -/// The response contains an array of Breakpoint objects with information about -/// each exception breakpoint or filter. The Breakpoint objects are in the same -/// order as the elements of the 'filters', 'filterOptions', 'exceptionOptions' -/// arrays given as arguments. If both 'filters' and 'filterOptions' are given, -/// the returned array must start with 'filters' information first, followed by -/// 'filterOptions' information. -/// The mandatory 'verified' property of a Breakpoint object signals whether the +/// Response to `setExceptionBreakpoints` request. +/// The response contains an array of `Breakpoint` objects with information +/// about each exception breakpoint or filter. The `Breakpoint` objects are in +/// the same order as the elements of the `filters`, `filterOptions`, +/// `exceptionOptions` arrays given as arguments. If both `filters` and +/// `filterOptions` are given, the returned array must start with `filters` +/// information first, followed by `filterOptions` information. +/// The `verified` property of a `Breakpoint` object signals whether the /// exception breakpoint or filter could be successfully created and whether the -/// optional condition or hit count expressions are valid. In case of an error -/// the 'message' property explains the problem. An optional 'id' property can -/// be used to introduce a unique ID for the exception breakpoint or filter so -/// that it can be updated subsequently by sending breakpoint events. -/// For backward compatibility both the 'breakpoints' array and the enclosing -/// 'body' are optional. If these elements are missing a client will not be able -/// to show problems for individual exception breakpoints or filters. +/// condition or hit count expressions are valid. In case of an error the +/// `message` property explains the problem. The `id` property can be used to +/// introduce a unique ID for the exception breakpoint or filter so that it can +/// be updated subsequently by sending breakpoint events. +/// For backward compatibility both the `breakpoints` array and the enclosing +/// `body` are optional. If these elements are missing a client is not able to +/// show problems for individual exception breakpoints or filters. class SetExceptionBreakpointsResponse extends Response { static SetExceptionBreakpointsResponse fromJson(Map obj) => SetExceptionBreakpointsResponse.fromMap(obj); @@ -4628,7 +4749,7 @@ class SetExceptionBreakpointsResponse extends Response { }; } -/// Arguments for 'setExpression' request. +/// Arguments for `setExpression` request. class SetExpressionArguments extends RequestArguments { /// The l-value expression to assign to. final String expression; @@ -4688,7 +4809,7 @@ class SetExpressionArguments extends RequestArguments { }; } -/// Response to 'setExpression' request. +/// Response to `setExpression` request. class SetExpressionResponse extends Response { static SetExpressionResponse fromJson(Map obj) => SetExpressionResponse.fromMap(obj); @@ -4727,7 +4848,7 @@ class SetExpressionResponse extends Response { }; } -/// Arguments for 'setFunctionBreakpoints' request. +/// Arguments for `setFunctionBreakpoints` request. class SetFunctionBreakpointsArguments extends RequestArguments { /// The function names of the breakpoints. final List breakpoints; @@ -4762,7 +4883,7 @@ class SetFunctionBreakpointsArguments extends RequestArguments { }; } -/// Response to 'setFunctionBreakpoints' request. +/// Response to `setFunctionBreakpoints` request. /// Returned is information about each breakpoint created by this request. class SetFunctionBreakpointsResponse extends Response { static SetFunctionBreakpointsResponse fromJson(Map obj) => @@ -4803,7 +4924,7 @@ class SetFunctionBreakpointsResponse extends Response { }; } -/// Arguments for 'setInstructionBreakpoints' request +/// Arguments for `setInstructionBreakpoints` request class SetInstructionBreakpointsArguments extends RequestArguments { /// The instruction references of the breakpoints final List breakpoints; @@ -4839,7 +4960,7 @@ class SetInstructionBreakpointsArguments extends RequestArguments { }; } -/// Response to 'setInstructionBreakpoints' request +/// Response to `setInstructionBreakpoints` request class SetInstructionBreakpointsResponse extends Response { static SetInstructionBreakpointsResponse fromJson(Map obj) => SetInstructionBreakpointsResponse.fromMap(obj); @@ -4879,7 +5000,7 @@ class SetInstructionBreakpointsResponse extends Response { }; } -/// Arguments for 'setVariable' request. +/// Arguments for `setVariable` request. class SetVariableArguments extends RequestArguments { /// Specifies details on how to format the response value. final ValueFormat? format; @@ -4890,7 +5011,9 @@ class SetVariableArguments extends RequestArguments { /// The value of the variable. final String value; - /// The reference of the variable container. + /// The reference of the variable container. The `variablesReference` must + /// have been obtained in the current suspended state. See 'Lifetime of Object + /// References' in the Overview section for details. final int variablesReference; static SetVariableArguments fromJson(Map obj) => @@ -4938,7 +5061,7 @@ class SetVariableArguments extends RequestArguments { }; } -/// Response to 'setVariable' request. +/// Response to `setVariable` request. class SetVariableResponse extends Response { static SetVariableResponse fromJson(Map obj) => SetVariableResponse.fromMap(obj); @@ -4977,11 +5100,12 @@ class SetVariableResponse extends Response { }; } -/// 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. +/// 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. class Source { - /// Optional data that a debug adapter might want to loop through the client. + /// Additional data that a debug adapter might want to loop through the + /// client. /// The client should leave the data intact and persist it across sessions. /// The client should not interpret the data. final Object? adapterData; @@ -4994,29 +5118,29 @@ class Source { /// When sending a source to the debug adapter this name is optional. final String? name; - /// The (optional) origin of this source: possible values 'internal module', - /// 'inlined content from source map', etc. + /// The origin of this source. For example, 'internal module', 'inlined + /// content from source map', etc. final String? origin; /// The path of the source to be shown in the UI. /// It is only used to locate and load the content of the source if no - /// sourceReference is specified (or its value is 0). + /// `sourceReference` is specified (or its value is 0). final String? path; - /// An optional hint for how to present the source in the UI. - /// A value of 'deemphasize' can be used to indicate that the source is not + /// A hint for how to present the source in the UI. + /// A value of `deemphasize` can be used to indicate that the source is not /// available or that it is skipped on stepping. final String? presentationHint; - /// If sourceReference > 0 the contents of the source must be retrieved - /// through the SourceRequest (even if a path is specified). - /// A sourceReference is only valid for a session, so it must not be used to - /// persist a source. + /// If the value > 0 the contents of the source must be retrieved through the + /// `source` request (even if a path is specified). + /// Since a `sourceReference` is only valid for a session, it can not be used + /// to persist a source. /// The value should be less than or equal to 2147483647 (2^31-1). final int? sourceReference; - /// An optional list of sources that are related to this source. These may be - /// the source that generated this source. + /// A list of sources that are related to this source. These may be the source + /// that generated this source. final List? sources; static Source fromJson(Map obj) => Source.fromMap(obj); @@ -5088,15 +5212,15 @@ class Source { }; } -/// Arguments for 'source' request. +/// Arguments for `source` request. class SourceArguments extends RequestArguments { - /// Specifies the source content to load. Either source.path or - /// source.sourceReference must be specified. + /// Specifies the source content to load. Either `source.path` or + /// `source.sourceReference` must be specified. final Source? source; - /// The reference to the source. This is the same as source.sourceReference. - /// This is provided for backward compatibility since old backends do not - /// understand the 'source' attribute. + /// The reference to the source. This is the same as `source.sourceReference`. + /// This is provided for backward compatibility since old clients do not + /// understand the `source` attribute. final int sourceReference; static SourceArguments fromJson(Map obj) => @@ -5132,31 +5256,38 @@ class SourceArguments extends RequestArguments { }; } -/// Properties of a breakpoint or logpoint passed to the setBreakpoints request. +/// Properties of a breakpoint or logpoint passed to the `setBreakpoints` +/// request. class SourceBreakpoint { - /// An optional source column of the breakpoint. + /// Start position within source line of the breakpoint or logpoint. It is + /// measured in UTF-16 code units and the client capability `columnsStartAt1` + /// determines whether it is 0- or 1-based. final int? column; - /// An optional expression for conditional breakpoints. - /// It is only honored by a debug adapter if the capability - /// 'supportsConditionalBreakpoints' is true. + /// The expression for conditional breakpoints. + /// It is only honored by a debug adapter if the corresponding capability + /// `supportsConditionalBreakpoints` is true. final String? condition; - /// An optional expression that controls how many hits of the breakpoint are - /// ignored. - /// The backend is expected to interpret the expression as needed. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportsHitConditionalBreakpoints' is true. + /// The expression that controls how many hits of the breakpoint are ignored. + /// The debug adapter is expected to interpret the expression as needed. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsHitConditionalBreakpoints` is true. + /// If both this property and `condition` are specified, `hitCondition` should + /// be evaluated only if the `condition` is met, and the debug adapter should + /// stop only if both conditions are met. final String? hitCondition; /// The source line of the breakpoint or logpoint. final int line; - /// If this attribute exists and is non-empty, the backend must not 'break' - /// (stop) - /// but log the message instead. Expressions within {} are interpolated. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportsLogPoints' is true. + /// If this attribute exists and is non-empty, the debug adapter must not + /// 'break' (stop) + /// but log the message instead. Expressions within `{}` are interpolated. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsLogPoints` is true. + /// If either `hitCondition` or `condition` is specified, then the message + /// should only be logged if those conditions are met. final String? logMessage; static SourceBreakpoint fromJson(Map obj) => @@ -5208,7 +5339,7 @@ class SourceBreakpoint { }; } -/// Response to 'source' request. +/// Response to `source` request. class SourceResponse extends Response { static SourceResponse fromJson(Map obj) => SourceResponse.fromMap(obj); @@ -5249,32 +5380,37 @@ class SourceResponse extends Response { /// A Stackframe contains the source location. class StackFrame { - /// Indicates whether this frame can be restarted with the 'restart' request. - /// Clients should only use this if the debug adapter supports the 'restart' - /// request (capability 'supportsRestartRequest' is true). + /// Indicates whether this frame can be restarted with the `restart` request. + /// Clients should only use this if the debug adapter supports the `restart` + /// request and the corresponding capability `supportsRestartRequest` is true. + /// If a debug adapter has this capability, then `canRestart` defaults to + /// `true` if the property is absent. final bool? canRestart; - /// The column within the line. If source is null or doesn't exist, column is - /// 0 and must be ignored. + /// Start position of the range covered by the stack frame. It is measured in + /// UTF-16 code units and the client capability `columnsStartAt1` determines + /// whether it is 0- or 1-based. If attribute `source` is missing or doesn't + /// exist, `column` is 0 and should be ignored by the client. final int column; - /// An optional end column of the range covered by the stack frame. + /// End position of the range covered by the stack frame. It is measured in + /// UTF-16 code units and the client capability `columnsStartAt1` determines + /// whether it is 0- or 1-based. final int? endColumn; - /// An optional end line of the range covered by the stack frame. + /// The end line of the range covered by the stack frame. final int? endLine; /// An identifier for the stack frame. It must be unique across all threads. - /// This id can be used to retrieve the scopes of the frame with the - /// 'scopesRequest' or to restart the execution of a stackframe. + /// This id can be used to retrieve the scopes of the frame with the `scopes` + /// request or to restart the execution of a stack frame. final int id; - /// Optional memory reference for the current instruction pointer in this - /// frame. + /// A memory reference for the current instruction pointer in this frame. final String? instructionPointerReference; - /// The line within the file of the frame. If source is null or doesn't exist, - /// line is 0 and must be ignored. + /// The line within the source of the frame. If the source attribute is + /// missing or doesn't exist, `line` is 0 and should be ignored by the client. final int line; /// The module associated with this frame, if any. @@ -5283,13 +5419,13 @@ class StackFrame { /// The name of the stack frame, typically a method name. final String name; - /// An optional hint for how to present this frame in the UI. - /// A value of 'label' can be used to indicate that the frame is an artificial - /// frame that is used as a visual label or separator. A value of 'subtle' can + /// A hint for how to present this frame in the UI. + /// A value of `label` can be used to indicate that the frame is an artificial + /// frame that is used as a visual label or separator. A value of `subtle` can /// be used to change the appearance of a frame in a 'subtle' way. final String? presentationHint; - /// The optional source of the frame. + /// The source of the frame. final Source? source; static StackFrame fromJson(Map obj) => @@ -5478,11 +5614,11 @@ class StackFrameFormat extends ValueFormat { }; } -/// Arguments for 'stackTrace' request. +/// Arguments for `stackTrace` request. class StackTraceArguments extends RequestArguments { /// Specifies details on how to format the stack frames. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportsValueFormattingOptions' is true. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsValueFormattingOptions` is true. final StackFrameFormat? format; /// The maximum number of frames to return. If levels is not specified or 0, @@ -5540,7 +5676,7 @@ class StackTraceArguments extends RequestArguments { }; } -/// Response to 'stackTrace' request. +/// Response to `stackTrace` request. class StackTraceResponse extends Response { static StackTraceResponse fromJson(Map obj) => StackTraceResponse.fromMap(obj); @@ -5579,13 +5715,97 @@ class StackTraceResponse extends Response { }; } -/// Arguments for 'stepBack' request. +/// Arguments for `startDebugging` request. +class StartDebuggingRequestArguments extends RequestArguments { + /// Arguments passed to the new debug session. The arguments must only contain + /// properties understood by the `launch` or `attach` requests of the debug + /// adapter and they must not contain any client-specific properties (e.g. + /// `type`) or client-specific features (e.g. substitutable 'variables'). + final Map configuration; + + /// Indicates whether the new debug session should be started with a `launch` + /// or `attach` request. + final String request; + + static StartDebuggingRequestArguments fromJson(Map obj) => + StartDebuggingRequestArguments.fromMap(obj); + + StartDebuggingRequestArguments({ + required this.configuration, + required this.request, + }); + + StartDebuggingRequestArguments.fromMap(Map obj) + : configuration = obj['configuration'] as Map, + request = obj['request'] as String; + + static bool canParse(Object? obj) { + if (obj is! Map) { + return false; + } + if (obj['configuration'] is! Map) { + return false; + } + if (obj['request'] is! String) { + return false; + } + return RequestArguments.canParse(obj); + } + + Map toJson() => { + 'configuration': configuration, + 'request': request, + }; +} + +/// Response to `startDebugging` request. This is just an acknowledgement, so no +/// body field is required. +class StartDebuggingResponse extends Response { + static StartDebuggingResponse fromJson(Map obj) => + StartDebuggingResponse.fromMap(obj); + + StartDebuggingResponse({ + Object? body, + required String command, + String? message, + required int requestSeq, + required int seq, + required bool success, + }) : super( + seq: seq, + requestSeq: requestSeq, + success: success, + command: command, + message: message, + body: body, + ); + + StartDebuggingResponse.fromMap(Map obj) : super.fromMap(obj); + + static bool canParse(Object? obj) { + if (obj is! Map) { + return false; + } + return Response.canParse(obj); + } + + @override + Map toJson() => { + ...super.toJson(), + }; +} + +/// Arguments for `stepBack` request. class StepBackArguments extends RequestArguments { - /// Optional granularity to step. If no granularity is specified, a - /// granularity of 'statement' is assumed. + /// Stepping granularity to step. If no granularity is specified, a + /// granularity of `statement` is assumed. final SteppingGranularity? granularity; - /// Execute 'stepBack' for this thread. + /// If this flag is true, all other suspended threads are not resumed. + final bool? singleThread; + + /// Specifies the thread for which to resume execution for one step backwards + /// (of the given granularity). final int threadId; static StepBackArguments fromJson(Map obj) => @@ -5593,11 +5813,13 @@ class StepBackArguments extends RequestArguments { StepBackArguments({ this.granularity, + this.singleThread, required this.threadId, }); StepBackArguments.fromMap(Map obj) : granularity = obj['granularity'] as SteppingGranularity?, + singleThread = obj['singleThread'] as bool?, threadId = obj['threadId'] as int; static bool canParse(Object? obj) { @@ -5607,6 +5829,9 @@ class StepBackArguments extends RequestArguments { if (obj['granularity'] is! SteppingGranularity?) { return false; } + if (obj['singleThread'] is! bool?) { + return false; + } if (obj['threadId'] is! int) { return false; } @@ -5615,11 +5840,12 @@ class StepBackArguments extends RequestArguments { Map toJson() => { if (granularity != null) 'granularity': granularity, + if (singleThread != null) 'singleThread': singleThread, 'threadId': threadId, }; } -/// Response to 'stepBack' request. This is just an acknowledgement, so no body +/// Response to `stepBack` request. This is just an acknowledgement, so no body /// field is required. class StepBackResponse extends Response { static StepBackResponse fromJson(Map obj) => @@ -5656,16 +5882,20 @@ class StepBackResponse extends Response { }; } -/// Arguments for 'stepIn' request. +/// Arguments for `stepIn` request. class StepInArguments extends RequestArguments { - /// Optional granularity to step. If no granularity is specified, a - /// granularity of 'statement' is assumed. + /// Stepping granularity. If no granularity is specified, a granularity of + /// `statement` is assumed. final SteppingGranularity? granularity; - /// Optional id of the target to step into. + /// If this flag is true, all other suspended threads are not resumed. + final bool? singleThread; + + /// Id of the target to step into. final int? targetId; - /// Execute 'stepIn' for this thread. + /// Specifies the thread for which to resume execution for one step-into (of + /// the given granularity). final int threadId; static StepInArguments fromJson(Map obj) => @@ -5673,12 +5903,14 @@ class StepInArguments extends RequestArguments { StepInArguments({ this.granularity, + this.singleThread, this.targetId, required this.threadId, }); StepInArguments.fromMap(Map obj) : granularity = obj['granularity'] as SteppingGranularity?, + singleThread = obj['singleThread'] as bool?, targetId = obj['targetId'] as int?, threadId = obj['threadId'] as int; @@ -5689,6 +5921,9 @@ class StepInArguments extends RequestArguments { if (obj['granularity'] is! SteppingGranularity?) { return false; } + if (obj['singleThread'] is! bool?) { + return false; + } if (obj['targetId'] is! int?) { return false; } @@ -5700,12 +5935,13 @@ class StepInArguments extends RequestArguments { Map toJson() => { if (granularity != null) 'granularity': granularity, + if (singleThread != null) 'singleThread': singleThread, if (targetId != null) 'targetId': targetId, 'threadId': threadId, }; } -/// Response to 'stepIn' request. This is just an acknowledgement, so no body +/// Response to `stepIn` request. This is just an acknowledgement, so no body /// field is required. class StepInResponse extends Response { static StepInResponse fromJson(Map obj) => @@ -5742,49 +5978,89 @@ class StepInResponse extends Response { }; } -/// A StepInTarget can be used in the 'stepIn' request and determines into which -/// single target the stepIn request should step. +/// A `StepInTarget` can be used in the `stepIn` request and determines into +/// which single target the `stepIn` request should step. class StepInTarget { - /// Unique identifier for a stepIn target. + /// Start position of the range covered by the step in target. It is measured + /// in UTF-16 code units and the client capability `columnsStartAt1` + /// determines whether it is 0- or 1-based. + final int? column; + + /// End position of the range covered by the step in target. It is measured in + /// UTF-16 code units and the client capability `columnsStartAt1` determines + /// whether it is 0- or 1-based. + final int? endColumn; + + /// The end line of the range covered by the step-in target. + final int? endLine; + + /// Unique identifier for a step-in target. final int id; - /// The name of the stepIn target (shown in the UI). + /// The name of the step-in target (shown in the UI). final String label; + /// The line of the step-in target. + final int? line; + static StepInTarget fromJson(Map obj) => StepInTarget.fromMap(obj); StepInTarget({ + this.column, + this.endColumn, + this.endLine, required this.id, required this.label, + this.line, }); StepInTarget.fromMap(Map obj) - : id = obj['id'] as int, - label = obj['label'] as String; + : column = obj['column'] as int?, + endColumn = obj['endColumn'] as int?, + endLine = obj['endLine'] as int?, + id = obj['id'] as int, + label = obj['label'] as String, + line = obj['line'] as int?; static bool canParse(Object? obj) { if (obj is! Map) { return false; } + if (obj['column'] is! int?) { + return false; + } + if (obj['endColumn'] is! int?) { + return false; + } + if (obj['endLine'] is! int?) { + return false; + } if (obj['id'] is! int) { return false; } if (obj['label'] is! String) { return false; } + if (obj['line'] is! int?) { + return false; + } return true; } Map toJson() => { + if (column != null) 'column': column, + if (endColumn != null) 'endColumn': endColumn, + if (endLine != null) 'endLine': endLine, 'id': id, 'label': label, + if (line != null) 'line': line, }; } -/// Arguments for 'stepInTargets' request. +/// Arguments for `stepInTargets` request. class StepInTargetsArguments extends RequestArguments { - /// The stack frame for which to retrieve the possible stepIn targets. + /// The stack frame for which to retrieve the possible step-in targets. final int frameId; static StepInTargetsArguments fromJson(Map obj) => @@ -5812,7 +6088,7 @@ class StepInTargetsArguments extends RequestArguments { }; } -/// Response to 'stepInTargets' request. +/// Response to `stepInTargets` request. class StepInTargetsResponse extends Response { static StepInTargetsResponse fromJson(Map obj) => StepInTargetsResponse.fromMap(obj); @@ -5851,13 +6127,17 @@ class StepInTargetsResponse extends Response { }; } -/// Arguments for 'stepOut' request. +/// Arguments for `stepOut` request. class StepOutArguments extends RequestArguments { - /// Optional granularity to step. If no granularity is specified, a - /// granularity of 'statement' is assumed. + /// Stepping granularity. If no granularity is specified, a granularity of + /// `statement` is assumed. final SteppingGranularity? granularity; - /// Execute 'stepOut' for this thread. + /// If this flag is true, all other suspended threads are not resumed. + final bool? singleThread; + + /// Specifies the thread for which to resume execution for one step-out (of + /// the given granularity). final int threadId; static StepOutArguments fromJson(Map obj) => @@ -5865,11 +6145,13 @@ class StepOutArguments extends RequestArguments { StepOutArguments({ this.granularity, + this.singleThread, required this.threadId, }); StepOutArguments.fromMap(Map obj) : granularity = obj['granularity'] as SteppingGranularity?, + singleThread = obj['singleThread'] as bool?, threadId = obj['threadId'] as int; static bool canParse(Object? obj) { @@ -5879,6 +6161,9 @@ class StepOutArguments extends RequestArguments { if (obj['granularity'] is! SteppingGranularity?) { return false; } + if (obj['singleThread'] is! bool?) { + return false; + } if (obj['threadId'] is! int) { return false; } @@ -5887,11 +6172,12 @@ class StepOutArguments extends RequestArguments { Map toJson() => { if (granularity != null) 'granularity': granularity, + if (singleThread != null) 'singleThread': singleThread, 'threadId': threadId, }; } -/// Response to 'stepOut' request. This is just an acknowledgement, so no body +/// Response to `stepOut` request. This is just an acknowledgement, so no body /// field is required. class StepOutResponse extends Response { static StepOutResponse fromJson(Map obj) => @@ -5928,13 +6214,13 @@ class StepOutResponse extends Response { }; } -/// The granularity of one 'step' in the stepping requests 'next', 'stepIn', -/// 'stepOut', and 'stepBack'. +/// The granularity of one 'step' in the stepping requests `next`, `stepIn`, +/// `stepOut`, and `stepBack`. typedef SteppingGranularity = String; -/// Arguments for 'terminate' request. +/// Arguments for `terminate` request. class TerminateArguments extends RequestArguments { - /// A value of true indicates that this 'terminate' request is part of a + /// A value of true indicates that this `terminate` request is part of a /// restart sequence. final bool? restart; @@ -5963,7 +6249,7 @@ class TerminateArguments extends RequestArguments { }; } -/// Response to 'terminate' request. This is just an acknowledgement, so no body +/// Response to `terminate` request. This is just an acknowledgement, so no body /// field is required. class TerminateResponse extends Response { static TerminateResponse fromJson(Map obj) => @@ -6000,7 +6286,7 @@ class TerminateResponse extends Response { }; } -/// Arguments for 'terminateThreads' request. +/// Arguments for `terminateThreads` request. class TerminateThreadsArguments extends RequestArguments { /// Ids of threads to be terminated. final List? threadIds; @@ -6032,8 +6318,8 @@ class TerminateThreadsArguments extends RequestArguments { }; } -/// Response to 'terminateThreads' request. This is just an acknowledgement, so -/// no body field is required. +/// Response to `terminateThreads` request. This is just an acknowledgement, no +/// body field is required. class TerminateThreadsResponse extends Response { static TerminateThreadsResponse fromJson(Map obj) => TerminateThreadsResponse.fromMap(obj); @@ -6075,7 +6361,7 @@ class Thread { /// Unique identifier for the thread. final int id; - /// A name of the thread. + /// The name of the thread. final String name; static Thread fromJson(Map obj) => Thread.fromMap(obj); @@ -6108,7 +6394,7 @@ class Thread { }; } -/// Response to 'threads' request. +/// Response to `threads` request. class ThreadsResponse extends Response { static ThreadsResponse fromJson(Map obj) => ThreadsResponse.fromMap(obj); @@ -6177,40 +6463,39 @@ class ValueFormat { } /// 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. +/// The `type` attribute is shown if space permits or when hovering over the +/// variable's name. +/// The `kind` attribute 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. +/// the children with the `variables` request. /// 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. +/// returned via the `namedVariables` and `indexedVariables` attributes. +/// The client can use this information to present the children in a paged UI +/// and fetch them in chunks. class Variable { - /// Optional evaluable name of this variable which can be passed to the - /// 'EvaluateRequest' to fetch the variable's value. + /// The evaluatable name of this variable which can be passed to the + /// `evaluate` request to fetch the variable's value. final String? evaluateName; /// The number of indexed child variables. - /// The client can use this optional information to present the children in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the children in a paged UI + /// and fetch them in chunks. final int? indexedVariables; - /// Optional memory reference for the variable if the variable represents + /// The memory reference for the variable if the variable represents /// executable code, such as a function pointer. - /// This attribute is only required if the client has passed the value true - /// for the 'supportsMemoryReferences' capability of the 'initialize' request. + /// This attribute is only required if the corresponding capability + /// `supportsMemoryReferences` is true. final String? memoryReference; /// The variable's name. final String name; /// The number of named child variables. - /// The client can use this optional information to present the children in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the children in a paged UI + /// and fetch them in chunks. final int? namedVariables; /// Properties of a variable that can be used to determine how to render the @@ -6219,17 +6504,23 @@ class Variable { /// The type of the variable's value. Typically shown in the UI when hovering /// over the value. - /// This attribute should only be returned by a debug adapter if the client - /// has passed the value true for the 'supportsVariableType' capability of the - /// 'initialize' request. + /// This attribute should only be returned by a debug adapter if the + /// corresponding capability `supportsVariableType` is true. final String? type; - /// The variable's value. This can be a multi-line text, e.g. for a function - /// the body of a function. + /// The variable's value. + /// This can be a multi-line text, e.g. for a function the body of a function. + /// For structured variables (which do not have a simple value), it is + /// recommended to provide a one-line representation of the structured object. + /// This helps to identify the structured object in the collapsed state when + /// its children are not yet visible. + /// An empty string can be used if no value should be shown in the UI. final String value; - /// If variablesReference is > 0, the variable is structured and its children - /// can be retrieved by passing variablesReference to the VariablesRequest. + /// If `variablesReference` is > 0, the variable is structured and its + /// children can be retrieved by passing `variablesReference` to the + /// `variables` request as long as execution remains suspended. See 'Lifetime + /// of Object References' in the Overview section for details. final int variablesReference; static Variable fromJson(Map obj) => Variable.fromMap(obj); @@ -6307,8 +6598,8 @@ class Variable { }; } -/// Optional properties of a variable that can be used to determine how to -/// render the variable in the UI. +/// Properties of a variable that can be used to determine how to render the +/// variable in the UI. class VariablePresentationHint { /// Set of attributes represented as an array of strings. Before introducing /// additional values, try to use the listed values. @@ -6318,6 +6609,17 @@ class VariablePresentationHint { /// listed values. final String? kind; + /// If true, clients can present the variable with a UI that supports a + /// specific gesture to trigger its evaluation. + /// This mechanism can be used for properties that require executing code when + /// retrieving their value and where the code execution can be expensive + /// and/or produce side-effects. A typical example are properties based on a + /// getter function. + /// Please note that in addition to the `lazy` flag, the variable's + /// `variablesReference` is expected to refer to a variable that will provide + /// the value through another `variable` request. + final bool? lazy; + /// Visibility of variable. Before introducing additional values, try to use /// the listed values. final String? visibility; @@ -6328,6 +6630,7 @@ class VariablePresentationHint { VariablePresentationHint({ this.attributes, this.kind, + this.lazy, this.visibility, }); @@ -6336,6 +6639,7 @@ class VariablePresentationHint { ?.map((item) => item as String) .toList(), kind = obj['kind'] as String?, + lazy = obj['lazy'] as bool?, visibility = obj['visibility'] as String?; static bool canParse(Object? obj) { @@ -6349,6 +6653,9 @@ class VariablePresentationHint { if (obj['kind'] is! String?) { return false; } + if (obj['lazy'] is! bool?) { + return false; + } if (obj['visibility'] is! String?) { return false; } @@ -6358,29 +6665,36 @@ class VariablePresentationHint { Map toJson() => { if (attributes != null) 'attributes': attributes, if (kind != null) 'kind': kind, + if (lazy != null) 'lazy': lazy, if (visibility != null) 'visibility': visibility, }; } -/// Arguments for 'variables' request. +/// Arguments for `variables` request. class VariablesArguments extends RequestArguments { /// The number of variables to return. If count is missing or 0, all variables /// are returned. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsVariablePaging` is true. final int? count; - /// Optional filter to limit the child variables to either named or indexed. - /// If omitted, both types are fetched. + /// Filter to limit the child variables to either named or indexed. If + /// omitted, both types are fetched. final String? filter; /// Specifies details on how to format the Variable values. - /// The attribute is only honored by a debug adapter if the capability - /// 'supportsValueFormattingOptions' is true. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsValueFormattingOptions` is true. final ValueFormat? format; /// The index of the first variable to return; if omitted children start at 0. + /// The attribute is only honored by a debug adapter if the corresponding + /// capability `supportsVariablePaging` is true. final int? start; - /// The Variable reference. + /// The variable for which to retrieve its children. The `variablesReference` + /// must have been obtained in the current suspended state. See 'Lifetime of + /// Object References' in the Overview section for details. final int variablesReference; static VariablesArguments fromJson(Map obj) => @@ -6434,7 +6748,7 @@ class VariablesArguments extends RequestArguments { }; } -/// Response to 'variables' request. +/// Response to `variables` request. class VariablesResponse extends Response { static VariablesResponse fromJson(Map obj) => VariablesResponse.fromMap(obj); @@ -6473,8 +6787,111 @@ class VariablesResponse extends Response { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Arguments for `writeMemory` request. +class WriteMemoryArguments extends RequestArguments { + /// Property to control partial writes. If true, the debug adapter should + /// attempt to write memory even if the entire memory region is not writable. + /// In such a case the debug adapter should stop after hitting the first byte + /// of memory that cannot be written and return the number of bytes written in + /// the response via the `offset` and `bytesWritten` properties. + /// If false or missing, a debug adapter should attempt to verify the region + /// is writable before writing, and fail the response if it is not. + final bool? allowPartial; + + /// Bytes to write, encoded using base64. + final String data; + + /// Memory reference to the base location to which data should be written. + final String memoryReference; + + /// Offset (in bytes) to be applied to the reference location before writing + /// data. Can be negative. + final int? offset; + + static WriteMemoryArguments fromJson(Map obj) => + WriteMemoryArguments.fromMap(obj); + + WriteMemoryArguments({ + this.allowPartial, + required this.data, + required this.memoryReference, + this.offset, + }); + + WriteMemoryArguments.fromMap(Map obj) + : allowPartial = obj['allowPartial'] as bool?, + data = obj['data'] as String, + memoryReference = obj['memoryReference'] as String, + offset = obj['offset'] as int?; + + static bool canParse(Object? obj) { + if (obj is! Map) { + return false; + } + if (obj['allowPartial'] is! bool?) { + return false; + } + if (obj['data'] is! String) { + return false; + } + if (obj['memoryReference'] is! String) { + return false; + } + if (obj['offset'] is! int?) { + return false; + } + return RequestArguments.canParse(obj); + } + + Map toJson() => { + if (allowPartial != null) 'allowPartial': allowPartial, + 'data': data, + 'memoryReference': memoryReference, + if (offset != null) 'offset': offset, + }; +} + +/// Response to `writeMemory` request. +class WriteMemoryResponse extends Response { + static WriteMemoryResponse fromJson(Map obj) => + WriteMemoryResponse.fromMap(obj); + + WriteMemoryResponse({ + Map? body, + required String command, + String? message, + required int requestSeq, + required int seq, + required bool success, + }) : super( + seq: seq, + requestSeq: requestSeq, + success: success, + command: command, + message: message, + body: body, + ); + + WriteMemoryResponse.fromMap(Map obj) : super.fromMap(obj); + + static bool canParse(Object? obj) { + if (obj is! Map) { + return false; + } + if (obj['body'] is! Map?) { + return false; + } + return Response.canParse(obj); + } + + @override + Map toJson() => { + ...super.toJson(), + }; +} + +/// Contains request result if success is true and error details if success is +/// false. class AttachResponseBody { static AttachResponseBody fromJson(Map obj) => AttachResponseBody.fromMap(obj); @@ -6494,7 +6911,7 @@ class AttachResponseBody { } class BreakpointEventBody extends EventBody { - /// The 'id' attribute is used to find the target breakpoint and the other + /// The `id` attribute is used to find the target breakpoint, the other /// attributes are used as the new values. final Breakpoint breakpoint; @@ -6567,8 +6984,8 @@ class BreakpointLocationsResponseBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class CancelResponseBody { static CancelResponseBody fromJson(Map obj) => CancelResponseBody.fromMap(obj); @@ -6650,8 +7067,8 @@ class CompletionsResponseBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class ConfigurationDoneResponseBody { static ConfigurationDoneResponseBody fromJson(Map obj) => ConfigurationDoneResponseBody.fromMap(obj); @@ -6671,10 +7088,9 @@ class ConfigurationDoneResponseBody { } class ContinueResponseBody { - /// If true, the 'continue' request has ignored the specified thread and - /// continued all threads instead. - /// If this attribute is missing a value of 'true' is assumed for backward - /// compatibility. + /// The value true (or a missing property) signals to the client that all + /// threads have been resumed. The value false indicates that not all threads + /// were resumed. final bool? allThreadsContinued; static ContinueResponseBody fromJson(Map obj) => @@ -6704,7 +7120,7 @@ class ContinueResponseBody { } class ContinuedEventBody extends EventBody { - /// If 'allThreadsContinued' is true, a debug adapter can announce that all + /// If `allThreadsContinued` is true, a debug adapter can announce that all /// threads have continued. final bool? allThreadsContinued; @@ -6744,16 +7160,16 @@ class ContinuedEventBody extends EventBody { } class DataBreakpointInfoResponseBody { - /// Optional attribute listing the available access types for a potential data - /// breakpoint. A UI frontend could surface this information. + /// Attribute lists the available access types for a potential data + /// breakpoint. A UI client could surface this information. final List? accessTypes; - /// Optional attribute indicating that a potential data breakpoint could be - /// persisted across sessions. + /// Attribute indicates that a potential data breakpoint could be persisted + /// across sessions. final bool? canPersist; /// An identifier for the data on which a data breakpoint can be registered - /// with the setDataBreakpoints request or null if no data breakpoint is + /// with the `setDataBreakpoints` request or null if no data breakpoint is /// available. final Either2 dataId; @@ -6844,8 +7260,8 @@ class DisassembleResponseBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class DisconnectResponseBody { static DisconnectResponseBody fromJson(Map obj) => DisconnectResponseBody.fromMap(obj); @@ -6865,7 +7281,7 @@ class DisconnectResponseBody { } class ErrorResponseBody { - /// An optional, structured error message. + /// A structured error message. final Message? error; static ErrorResponseBody fromJson(Map obj) => @@ -6897,42 +7313,40 @@ class ErrorResponseBody { class EvaluateResponseBody { /// The number of indexed child variables. - /// The client can use this optional information to present the variables in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the variables in a paged UI + /// and fetch them in chunks. /// The value should be less than or equal to 2147483647 (2^31-1). final int? indexedVariables; - /// Optional memory reference to a location appropriate for this result. + /// A memory reference to a location appropriate for this result. /// For pointer type eval results, this is generally a reference to the memory /// address contained in the pointer. - /// This attribute should be returned by a debug adapter if the client has - /// passed the value true for the 'supportsMemoryReferences' capability of the - /// 'initialize' request. + /// This attribute should be returned by a debug adapter if corresponding + /// capability `supportsMemoryReferences` is true. final String? memoryReference; /// The number of named child variables. - /// The client can use this optional information to present the variables in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the variables in a paged UI + /// and fetch them in chunks. /// The value should be less than or equal to 2147483647 (2^31-1). final int? namedVariables; - /// Properties of a evaluate result that can be used to determine how to + /// Properties of an evaluate result that can be used to determine how to /// render the result in the UI. final VariablePresentationHint? presentationHint; /// The result of the evaluate request. final String result; - /// The optional type of the evaluate result. - /// This attribute should only be returned by a debug adapter if the client - /// has passed the value true for the 'supportsVariableType' capability of the - /// 'initialize' request. + /// The type of the evaluate result. + /// This attribute should only be returned by a debug adapter if the + /// corresponding capability `supportsVariableType` is true. final String? type; - /// If variablesReference is > 0, the evaluate result is structured and its - /// children can be retrieved by passing variablesReference to the - /// VariablesRequest. - /// The value should be less than or equal to 2147483647 (2^31-1). + /// If `variablesReference` is > 0, the evaluate result is structured and its + /// children can be retrieved by passing `variablesReference` to the + /// `variables` request as long as execution remains suspended. See 'Lifetime + /// of Object References' in the Overview section for details. final int variablesReference; static EvaluateResponseBody fromJson(Map obj) => @@ -7003,7 +7417,7 @@ class ExceptionInfoResponseBody { /// Mode that caused the exception notification to be raised. final ExceptionBreakMode breakMode; - /// Descriptive text for the exception provided by the debug adapter. + /// Descriptive text for the exception. final String? description; /// Detailed information about the exception. @@ -7086,8 +7500,8 @@ class ExitedEventBody extends EventBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class GotoResponseBody { static GotoResponseBody fromJson(Map obj) => GotoResponseBody.fromMap(obj); @@ -7177,15 +7591,15 @@ class InitializedEventBody extends EventBody { } class InvalidatedEventBody extends EventBody { - /// Optional set of logical areas that got invalidated. This property has a - /// hint characteristic: a client can only be expected to make a 'best effort' - /// in honouring the areas but there are no guarantees. If this property is - /// missing, empty, or if values are not understand the client should assume a - /// single value 'all'. + /// Set of logical areas that got invalidated. This property has a hint + /// characteristic: a client can only be expected to make a 'best effort' in + /// honoring the areas but there are no guarantees. If this property is + /// missing, empty, or if values are not understood, the client should assume + /// a single value `all`. final List? areas; /// If specified, the client only needs to refetch data related to this stack - /// frame (and the 'threadId' is ignored). + /// frame (and the `threadId` is ignored). final int? stackFrameId; /// If specified, the client only needs to refetch data related to this @@ -7232,8 +7646,8 @@ class InvalidatedEventBody extends EventBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class LaunchResponseBody { static LaunchResponseBody fromJson(Map obj) => LaunchResponseBody.fromMap(obj); @@ -7322,8 +7736,55 @@ class LoadedSourcesResponseBody { }; } +class MemoryEventBody extends EventBody { + /// Number of bytes updated. + final int count; + + /// Memory reference of a memory range that has been updated. + final String memoryReference; + + /// Starting offset in bytes where memory has been updated. Can be negative. + final int offset; + + static MemoryEventBody fromJson(Map obj) => + MemoryEventBody.fromMap(obj); + + MemoryEventBody({ + required this.count, + required this.memoryReference, + required this.offset, + }); + + MemoryEventBody.fromMap(Map obj) + : count = obj['count'] as int, + memoryReference = obj['memoryReference'] as String, + offset = obj['offset'] as int; + + static bool canParse(Object? obj) { + if (obj is! Map) { + return false; + } + if (obj['count'] is! int) { + return false; + } + if (obj['memoryReference'] is! String) { + return false; + } + if (obj['offset'] is! int) { + return false; + } + return EventBody.canParse(obj); + } + + Map toJson() => { + 'count': count, + 'memoryReference': memoryReference, + 'offset': offset, + }; +} + class ModuleEventBody extends EventBody { - /// The new, changed, or removed module. In case of 'removed' only the module + /// The new, changed, or removed module. In case of `removed` only the module /// id is used. final Module module; @@ -7402,8 +7863,8 @@ class ModulesResponseBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class NextResponseBody { static NextResponseBody fromJson(Map obj) => NextResponseBody.fromMap(obj); @@ -7423,33 +7884,36 @@ class NextResponseBody { } class OutputEventBody extends EventBody { - /// The output category. If not specified, 'console' is assumed. + /// The output category. If not specified or if the category is not understood + /// by the client, `console` is assumed. final String? category; - /// An optional source location column where the output was produced. + /// The position in `line` where the output was produced. It is measured in + /// UTF-16 code units and the client capability `columnsStartAt1` determines + /// whether it is 0- or 1-based. final int? column; - /// Optional data to report. For the 'telemetry' category the data will be - /// sent to telemetry, for the other categories the data is shown in JSON - /// format. + /// Additional data to report. For the `telemetry` category the data is sent + /// to telemetry, for the other categories the data is shown in JSON format. final Object? data; /// Support for keeping an output log organized by grouping related messages. final String? group; - /// An optional source location line where the output was produced. + /// The source location's line where the output was produced. final int? line; /// The output to report. final String output; - /// An optional source location where the output was produced. + /// The source location where the output was produced. final Source? source; - /// If an attribute 'variablesReference' exists and its value is > 0, the + /// If an attribute `variablesReference` exists and its value is > 0, the /// output contains objects which can be retrieved by passing - /// 'variablesReference' to the 'variables' request. The value should be less - /// than or equal to 2147483647 (2^31-1). + /// `variablesReference` to the `variables` request as long as execution + /// remains suspended. See 'Lifetime of Object References' in the Overview + /// section for details. final int? variablesReference; static OutputEventBody fromJson(Map obj) => @@ -7519,8 +7983,8 @@ class OutputEventBody extends EventBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class PauseResponseBody { static PauseResponseBody fromJson(Map obj) => PauseResponseBody.fromMap(obj); @@ -7554,8 +8018,8 @@ class ProcessEventBody extends EventBody { /// Describes how the debug engine started debugging this process. final String? startMethod; - /// The system process id of the debugged process. This property will be - /// missing for non-system processes. + /// The system process id of the debugged process. This property is missing + /// for non-system processes. final int? systemProcessId; static ProcessEventBody fromJson(Map obj) => @@ -7608,11 +8072,11 @@ class ProcessEventBody extends EventBody { } class ProgressEndEventBody extends EventBody { - /// Optional, more detailed progress message. If omitted, the previous message - /// (if any) is used. + /// More detailed progress message. If omitted, the previous message (if any) + /// is used. final String? message; - /// The ID that was introduced in the initial 'ProgressStartEvent'. + /// The ID that was introduced in the initial `ProgressStartEvent`. final String progressId; static ProgressEndEventBody fromJson(Map obj) => @@ -7647,35 +8111,34 @@ class ProgressEndEventBody extends EventBody { } class ProgressStartEventBody extends EventBody { - /// If true, the request that reports progress may be canceled with a 'cancel' - /// request. + /// If true, the request that reports progress may be cancelled with a + /// `cancel` request. /// So this property basically controls whether the client should use UX that /// supports cancellation. /// Clients that don't support cancellation are allowed to ignore the setting. final bool? cancellable; - /// Optional, more detailed progress message. + /// More detailed progress message. final String? message; - /// Optional progress percentage to display (value range: 0 to 100). If - /// omitted no percentage will be shown. + /// Progress percentage to display (value range: 0 to 100). If omitted no + /// percentage is shown. final num? percentage; - /// An ID that must be used in subsequent 'progressUpdate' and 'progressEnd' + /// An ID that can be used in subsequent `progressUpdate` and `progressEnd` /// events to make them refer to the same progress reporting. /// IDs must be unique within a debug session. final String progressId; /// The request ID that this progress report is related to. If specified a - /// debug adapter is expected to emit - /// progress events for the long running request until the request has been - /// either completed or cancelled. + /// debug adapter is expected to emit progress events for the long running + /// request until the request has been either completed or cancelled. /// If the request ID is omitted, the progress report is assumed to be related /// to some general activity of the debug adapter. final int? requestId; - /// Mandatory (short) title of the progress reporting. Shown in the UI to - /// describe the long running operation. + /// Short title of the progress reporting. Shown in the UI to describe the + /// long running operation. final String title; static ProgressStartEventBody fromJson(Map obj) => @@ -7734,15 +8197,15 @@ class ProgressStartEventBody extends EventBody { } class ProgressUpdateEventBody extends EventBody { - /// Optional, more detailed progress message. If omitted, the previous message - /// (if any) is used. + /// More detailed progress message. If omitted, the previous message (if any) + /// is used. final String? message; - /// Optional progress percentage to display (value range: 0 to 100). If - /// omitted no percentage will be shown. + /// Progress percentage to display (value range: 0 to 100). If omitted no + /// percentage is shown. final num? percentage; - /// The ID that was introduced in the initial 'progressStart' event. + /// The ID that was introduced in the initial `progressStart` event. final String progressId; static ProgressUpdateEventBody fromJson(Map obj) => @@ -7784,17 +8247,20 @@ class ProgressUpdateEventBody extends EventBody { class ReadMemoryResponseBody { /// The address of the first byte of data returned. - /// Treated as a hex value if prefixed with '0x', or as a decimal value + /// Treated as a hex value if prefixed with `0x`, or as a decimal value /// otherwise. final String address; - /// The bytes read from memory, encoded using base64. + /// The bytes read from memory, encoded using base64. If the decoded length of + /// `data` is less than the requested `count` in the original `readMemory` + /// request, and `unreadableBytes` is zero or omitted, then the client should + /// assume it's reached the end of readable memory. final String? data; /// The number of unreadable bytes encountered after the last successfully /// read byte. - /// This can be used to determine the number of bytes that must be skipped - /// before a subsequent 'readMemory' request will succeed. + /// This can be used to determine the number of bytes that should be skipped + /// before a subsequent `readMemory` request succeeds. final int? unreadableBytes; static ReadMemoryResponseBody fromJson(Map obj) => @@ -7834,8 +8300,8 @@ class ReadMemoryResponseBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class RestartFrameResponseBody { static RestartFrameResponseBody fromJson(Map obj) => RestartFrameResponseBody.fromMap(obj); @@ -7854,8 +8320,8 @@ class RestartFrameResponseBody { Map toJson() => {}; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class RestartResponseBody { static RestartResponseBody fromJson(Map obj) => RestartResponseBody.fromMap(obj); @@ -7874,8 +8340,8 @@ class RestartResponseBody { Map toJson() => {}; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class ReverseContinueResponseBody { static ReverseContinueResponseBody fromJson(Map obj) => ReverseContinueResponseBody.fromMap(obj); @@ -7935,7 +8401,7 @@ class RunInTerminalResponseBody { } class ScopesResponseBody { - /// The scopes of the stackframe. If the array has length zero, there are no + /// The scopes of the stack frame. If the array has length zero, there are no /// scopes available. final List scopes; @@ -7970,7 +8436,7 @@ class ScopesResponseBody { class SetBreakpointsResponseBody { /// Information about the breakpoints. /// The array elements are in the same order as the elements of the - /// 'breakpoints' (or the deprecated 'lines') array in the arguments. + /// `breakpoints` (or the deprecated `lines`) array in the arguments. final List breakpoints; static SetBreakpointsResponseBody fromJson(Map obj) => @@ -8003,7 +8469,7 @@ class SetBreakpointsResponseBody { class SetDataBreakpointsResponseBody { /// Information about the data breakpoints. The array elements correspond to - /// the elements of the input argument 'breakpoints' array. + /// the elements of the input argument `breakpoints` array. final List breakpoints; static SetDataBreakpointsResponseBody fromJson(Map obj) => @@ -8037,9 +8503,9 @@ class SetDataBreakpointsResponseBody { class SetExceptionBreakpointsResponseBody { /// Information about the exception breakpoints or filters. /// The breakpoints returned are in the same order as the elements of the - /// 'filters', 'filterOptions', 'exceptionOptions' arrays in the arguments. If - /// both 'filters' and 'filterOptions' are given, the returned array must - /// start with 'filters' information first, followed by 'filterOptions' + /// `filters`, `filterOptions`, `exceptionOptions` arrays in the arguments. If + /// both `filters` and `filterOptions` are given, the returned array must + /// start with `filters` information first, followed by `filterOptions` /// information. final List? breakpoints; @@ -8074,14 +8540,14 @@ class SetExceptionBreakpointsResponseBody { class SetExpressionResponseBody { /// The number of indexed child variables. - /// The client can use this optional information to present the variables in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the variables in a paged UI + /// and fetch them in chunks. /// The value should be less than or equal to 2147483647 (2^31-1). final int? indexedVariables; /// The number of named child variables. - /// The client can use this optional information to present the variables in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the variables in a paged UI + /// and fetch them in chunks. /// The value should be less than or equal to 2147483647 (2^31-1). final int? namedVariables; @@ -8089,18 +8555,18 @@ class SetExpressionResponseBody { /// result in the UI. final VariablePresentationHint? presentationHint; - /// The optional type of the value. - /// This attribute should only be returned by a debug adapter if the client - /// has passed the value true for the 'supportsVariableType' capability of the - /// 'initialize' request. + /// The type of the value. + /// This attribute should only be returned by a debug adapter if the + /// corresponding capability `supportsVariableType` is true. final String? type; /// The new value of the expression. final String value; - /// If variablesReference is > 0, the value is structured and its children can - /// be retrieved by passing variablesReference to the VariablesRequest. - /// The value should be less than or equal to 2147483647 (2^31-1). + /// If `variablesReference` is > 0, the evaluate result is structured and its + /// children can be retrieved by passing `variablesReference` to the + /// `variables` request as long as execution remains suspended. See 'Lifetime + /// of Object References' in the Overview section for details. final int? variablesReference; static SetExpressionResponseBody fromJson(Map obj) => @@ -8164,7 +8630,7 @@ class SetExpressionResponseBody { class SetFunctionBreakpointsResponseBody { /// Information about the breakpoints. The array elements correspond to the - /// elements of the 'breakpoints' array. + /// elements of the `breakpoints` array. final List breakpoints; static SetFunctionBreakpointsResponseBody fromJson( @@ -8198,7 +8664,7 @@ class SetFunctionBreakpointsResponseBody { class SetInstructionBreakpointsResponseBody { /// Information about the breakpoints. The array elements correspond to the - /// elements of the 'breakpoints' array. + /// elements of the `breakpoints` array. final List breakpoints; static SetInstructionBreakpointsResponseBody fromJson( @@ -8232,14 +8698,14 @@ class SetInstructionBreakpointsResponseBody { class SetVariableResponseBody { /// The number of indexed child variables. - /// The client can use this optional information to present the variables in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the variables in a paged UI + /// and fetch them in chunks. /// The value should be less than or equal to 2147483647 (2^31-1). final int? indexedVariables; /// The number of named child variables. - /// The client can use this optional information to present the variables in a - /// paged UI and fetch them in chunks. + /// The client can use this information to present the variables in a paged UI + /// and fetch them in chunks. /// The value should be less than or equal to 2147483647 (2^31-1). final int? namedVariables; @@ -8250,9 +8716,10 @@ class SetVariableResponseBody { /// The new value of the variable. final String value; - /// If variablesReference is > 0, the new value is structured and its children - /// can be retrieved by passing variablesReference to the VariablesRequest. - /// The value should be less than or equal to 2147483647 (2^31-1). + /// If `variablesReference` is > 0, the new value is structured and its + /// children can be retrieved by passing `variablesReference` to the + /// `variables` request as long as execution remains suspended. See 'Lifetime + /// of Object References' in the Overview section for details. final int? variablesReference; static SetVariableResponseBody fromJson(Map obj) => @@ -8309,7 +8776,7 @@ class SourceResponseBody { /// Content of the source reference. final String content; - /// Optional content type (mime type) of the source. + /// Content type (MIME type) of the source. final String? mimeType; static SourceResponseBody fromJson(Map obj) => @@ -8344,16 +8811,16 @@ class SourceResponseBody { } class StackTraceResponseBody { - /// The frames of the stackframe. If the array has length zero, there are no - /// stackframes available. + /// The frames of the stack frame. If the array has length zero, there are no + /// stack frames available. /// This means that there is no location information available. final List stackFrames; /// The total number of frames available in the stack. If omitted or if - /// totalFrames is larger than the available frames, a client is expected to + /// `totalFrames` is larger than the available frames, a client is expected to /// request frames until a request returns less frames than requested (which /// indicates the end of the stack). Returning monotonically increasing - /// totalFrames values for subsequent requests can be used to enforce paging + /// `totalFrames` values for subsequent requests can be used to enforce paging /// in the client. final int? totalFrames; @@ -8391,8 +8858,28 @@ class StackTraceResponseBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. +class StartDebuggingResponseBody { + static StartDebuggingResponseBody fromJson(Map obj) => + StartDebuggingResponseBody.fromMap(obj); + + StartDebuggingResponseBody(); + + StartDebuggingResponseBody.fromMap(Map obj); + + static bool canParse(Object? obj) { + if (obj is! Map) { + return false; + } + return true; + } + + Map toJson() => {}; +} + +/// Contains request result if success is true and error details if success is +/// false. class StepBackResponseBody { static StepBackResponseBody fromJson(Map obj) => StepBackResponseBody.fromMap(obj); @@ -8411,8 +8898,8 @@ class StepBackResponseBody { Map toJson() => {}; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class StepInResponseBody { static StepInResponseBody fromJson(Map obj) => StepInResponseBody.fromMap(obj); @@ -8432,7 +8919,7 @@ class StepInResponseBody { } class StepInTargetsResponseBody { - /// The possible stepIn targets of the specified source location. + /// The possible step-in targets of the specified source location. final List targets; static StepInTargetsResponseBody fromJson(Map obj) => @@ -8463,8 +8950,8 @@ class StepInTargetsResponseBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class StepOutResponseBody { static StepOutResponseBody fromJson(Map obj) => StepOutResponseBody.fromMap(obj); @@ -8484,34 +8971,34 @@ class StepOutResponseBody { } class StoppedEventBody extends EventBody { - /// If 'allThreadsStopped' is true, a debug adapter can announce that all + /// If `allThreadsStopped` is true, a debug adapter can announce that all /// threads have stopped. /// - The client should use this information to enable that all threads can be expanded to access their stacktraces. - /// - If the attribute is missing or false, only the thread with the given threadId can be expanded. + /// - If the attribute is missing or false, only the thread with the given `threadId` can be expanded. final bool? allThreadsStopped; /// The full reason for the event, e.g. 'Paused on exception'. This string is - /// shown in the UI as is and must be translated. + /// shown in the UI as is and can be translated. final String? description; - /// Ids of the breakpoints that triggered the event. In most cases there will - /// be only a single breakpoint but here are some examples for multiple + /// Ids of the breakpoints that triggered the event. In most cases there is + /// only a single breakpoint but here are some examples for multiple /// breakpoints: /// - Different types of breakpoints map to the same location. /// - Multiple source breakpoints get collapsed to the same instruction by the compiler/runtime. /// - Multiple function breakpoints with different function names map to the same location. final List? hitBreakpointIds; - /// A value of true hints to the frontend that this event should not change - /// the focus. + /// A value of true hints to the client that this event should not change the + /// focus. final bool? preserveFocusHint; /// The reason for the event. /// For backward compatibility this string is shown in the UI if the - /// 'description' attribute is missing (but it must not be translated). + /// `description` attribute is missing (but it must not be translated). final String reason; - /// Additional information. E.g. if reason is 'exception', text contains the + /// Additional information. E.g. if reason is `exception`, text contains the /// exception name. This string is shown in the UI. final String? text; @@ -8582,8 +9069,8 @@ class StoppedEventBody extends EventBody { }; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class TerminateResponseBody { static TerminateResponseBody fromJson(Map obj) => TerminateResponseBody.fromMap(obj); @@ -8602,8 +9089,8 @@ class TerminateResponseBody { Map toJson() => {}; } -/// Contains request result if success is true and optional error details if -/// success is false. +/// Contains request result if success is true and error details if success is +/// false. class TerminateThreadsResponseBody { static TerminateThreadsResponseBody fromJson(Map obj) => TerminateThreadsResponseBody.fromMap(obj); @@ -8623,10 +9110,10 @@ class TerminateThreadsResponseBody { } class TerminatedEventBody extends EventBody { - /// A debug adapter may set 'restart' to true (or to an arbitrary object) to - /// request that the front end restarts the session. + /// A debug adapter may set `restart` to true (or to an arbitrary object) to + /// request that the client restarts the session. /// The value is not interpreted by the client and passed unmodified as an - /// attribute '__restart' to the 'launch' and 'attach' requests. + /// attribute `__restart` to the `launch` and `attach` requests. final Object? restart; static TerminatedEventBody fromJson(Map obj) => @@ -8753,6 +9240,47 @@ class VariablesResponseBody { }; } +class WriteMemoryResponseBody { + /// Property that should be returned when `allowPartial` is true to indicate + /// the number of bytes starting from address that were successfully written. + final int? bytesWritten; + + /// Property that should be returned when `allowPartial` is true to indicate + /// the offset of the first byte of data successfully written. Can be + /// negative. + final int? offset; + + static WriteMemoryResponseBody fromJson(Map obj) => + WriteMemoryResponseBody.fromMap(obj); + + WriteMemoryResponseBody({ + this.bytesWritten, + this.offset, + }); + + WriteMemoryResponseBody.fromMap(Map obj) + : bytesWritten = obj['bytesWritten'] as int?, + offset = obj['offset'] as int?; + + static bool canParse(Object? obj) { + if (obj is! Map) { + return false; + } + if (obj['bytesWritten'] is! int?) { + return false; + } + if (obj['offset'] is! int?) { + return false; + } + return true; + } + + Map toJson() => { + if (bytesWritten != null) 'bytesWritten': bytesWritten, + if (offset != null) 'offset': offset, + }; +} + const eventTypes = { BreakpointEventBody: 'breakpoint', CapabilitiesEventBody: 'capabilities', @@ -8761,6 +9289,7 @@ const eventTypes = { InitializedEventBody: 'initialized', InvalidatedEventBody: 'invalidated', LoadedSourceEventBody: 'loadedSource', + MemoryEventBody: 'memory', ModuleEventBody: 'module', OutputEventBody: 'output', ProcessEventBody: 'process', @@ -8807,6 +9336,7 @@ const commandTypes = { SetVariableArguments: 'setVariable', SourceArguments: 'source', StackTraceArguments: 'stackTrace', + StartDebuggingRequestArguments: 'startDebugging', StepBackArguments: 'stepBack', StepInArguments: 'stepIn', StepInTargetsArguments: 'stepInTargets', @@ -8814,4 +9344,5 @@ const commandTypes = { TerminateArguments: 'terminate', TerminateThreadsArguments: 'terminateThreads', VariablesArguments: 'variables', + WriteMemoryArguments: 'writeMemory', }; diff --git a/pkg/dap/pubspec.yaml b/pkg/dap/pubspec.yaml index f83d36a96d4..d3e6090226d 100644 --- a/pkg/dap/pubspec.yaml +++ b/pkg/dap/pubspec.yaml @@ -1,5 +1,5 @@ name: dap -version: 1.0.0 +version: 1.1.0 description: >- A package of classes that are generated from the DAP specifications along with their generating code. diff --git a/pkg/dap/tool/external_dap_spec/debugAdapterProtocol.json b/pkg/dap/tool/external_dap_spec/debugAdapterProtocol.json index 31c2ef515d4..ecb6d4f75e5 100644 --- a/pkg/dap/tool/external_dap_spec/debugAdapterProtocol.json +++ b/pkg/dap/tool/external_dap_spec/debugAdapterProtocol.json @@ -14,7 +14,7 @@ "properties": { "seq": { "type": "integer", - "description": "Sequence number (also known as message ID). For protocol messages of type 'request' this ID can be used to cancel the request." + "description": "Sequence number of the message (also known as message ID). The `seq` for the first message sent by a client or debug adapter is 1, and for each subsequent message is 1 greater than the previous message sent by that actor. `seq` can be used to order requests, responses, and events, and to associate requests with their corresponding responses. For protocol messages of type `request` the sequence number can be used to cancel the request." }, "type": { "type": "string", @@ -84,7 +84,7 @@ }, "success": { "type": "boolean", - "description": "Outcome of the request.\nIf true, the request was successful and the 'body' attribute may contain the result of the request.\nIf the value is false, the attribute 'message' contains the error in short form and the 'body' may contain additional information (see 'ErrorResponse.body.error')." + "description": "Outcome of the request.\nIf true, the request was successful and the `body` attribute may contain the result of the request.\nIf the value is false, the attribute `message` contains the error in short form and the `body` may contain additional information (see `ErrorResponse.body.error`)." }, "command": { "type": "string", @@ -92,15 +92,16 @@ }, "message": { "type": "string", - "description": "Contains the raw error in short form if 'success' is false.\nThis raw error might be interpreted by the frontend and is not shown in the UI.\nSome predefined values exist.", - "_enum": [ "cancelled" ], + "description": "Contains the raw error in short form if `success` is false.\nThis raw error might be interpreted by the client and is not shown in the UI.\nSome predefined values exist.", + "_enum": [ "cancelled", "notStopped" ], "enumDescriptions": [ - "request was cancelled." + "the request was cancelled.", + "the request may be retried once the adapter is in a 'stopped' state." ] }, "body": { "type": [ "array", "boolean", "integer", "null", "number" , "object", "string" ], - "description": "Contains request result if success is true and optional error details if success is false." + "description": "Contains request result if success is true and error details if success is false." } }, "required": [ "type", "request_seq", "success", "command" ] @@ -110,14 +111,14 @@ "ErrorResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "On error (whenever 'success' is false), the body can provide more details.", + "description": "On error (whenever `success` is false), the body can provide more details.", "properties": { "body": { "type": "object", "properties": { "error": { "$ref": "#/definitions/Message", - "description": "An optional, structured error message." + "description": "A structured error message." } } } @@ -129,7 +130,7 @@ "CancelRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The 'cancel' request is used by the frontend in two situations:\n- to indicate that it is no longer interested in the result produced by a specific request issued earlier\n- to cancel a progress sequence. Clients should only call this request if the capability 'supportsCancelRequest' is true.\nThis 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.\nThe '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.\nA frontend client should only call this request if the capability 'supportsCancelRequest' is true.\nThe request that got canceled still needs to send a response back. This can either be a normal result ('success' attribute true)\nor an error response ('success' attribute false and the 'message' set to 'cancelled').\nReturning 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.\n The progress that got cancelled still needs to send a 'progressEnd' event back.\n A client should not assume that progress just got cancelled after sending the 'cancel' request.", + "description": "The `cancel` request is used by the client in two situations:\n- to indicate that it is no longer interested in the result produced by a specific request issued earlier\n- to cancel a progress sequence. Clients should only call this request if the corresponding capability `supportsCancelRequest` is true.\nThis request has a hint characteristic: a debug adapter can only be expected to make a 'best effort' in honoring this request but there are no guarantees.\nThe `cancel` request may return an error if it could not cancel an operation but a client should refrain from presenting this error to end users.\nThe request that got cancelled 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`).\nReturning partial results from a cancelled request is possible but please note that a client has no generic way for detecting that a response is partial or not.\nThe progress that got cancelled still needs to send a `progressEnd` event back.\n A client should not assume that progress just got cancelled after sending the `cancel` request.", "properties": { "command": { "type": "string", @@ -144,22 +145,22 @@ }, "CancelArguments": { "type": "object", - "description": "Arguments for 'cancel' request.", + "description": "Arguments for `cancel` request.", "properties": { "requestId": { "type": "integer", - "description": "The ID (attribute 'seq') of the request to cancel. If missing no request is cancelled.\nBoth a 'requestId' and a 'progressId' can be specified in one request." + "description": "The ID (attribute `seq`) of the request to cancel. If missing no request is cancelled.\nBoth a `requestId` and a `progressId` can be specified in one request." }, "progressId": { "type": "string", - "description": "The ID (attribute 'progressId') of the progress to cancel. If missing no progress is cancelled.\nBoth a 'requestId' and a 'progressId' can be specified in one request." + "description": "The ID (attribute `progressId`) of the progress to cancel. If missing no progress is cancelled.\nBoth a `requestId` and a `progressId` can be specified in one request." } } }, "CancelResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'cancel' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `cancel` request. This is just an acknowledgement, so no body field is required." }] }, @@ -167,7 +168,7 @@ "allOf": [ { "$ref": "#/definitions/Event" }, { "type": "object", "title": "Events", - "description": "This event indicates that the debug adapter is ready to accept configuration requests (e.g. SetBreakpointsRequest, SetExceptionBreakpointsRequest).\nA debug adapter is expected to send this event when it is ready to accept configuration requests (but not before the 'initialize' request has finished).\nThe sequence of events/requests is as follows:\n- adapters sends 'initialized' event (after the 'initialize' request has returned)\n- frontend sends zero or more 'setBreakpoints' requests\n- frontend sends one 'setFunctionBreakpoints' request (if capability 'supportsFunctionBreakpoints' is true)\n- frontend sends a 'setExceptionBreakpoints' request if one or more 'exceptionBreakpointFilters' have been defined (or if 'supportsConfigurationDoneRequest' is not defined or false)\n- frontend sends other future configuration requests\n- frontend sends one 'configurationDone' request to indicate the end of the configuration.", + "description": "This event indicates that the debug adapter is ready to accept configuration requests (e.g. `setBreakpoints`, `setExceptionBreakpoints`).\nA debug adapter is expected to send this event when it is ready to accept configuration requests (but not before the `initialize` request has finished).\nThe sequence of events/requests is as follows:\n- adapters sends `initialized` event (after the `initialize` request has returned)\n- client sends zero or more `setBreakpoints` requests\n- client sends one `setFunctionBreakpoints` request (if corresponding capability `supportsFunctionBreakpoints` is true)\n- client sends a `setExceptionBreakpoints` request if one or more `exceptionBreakpointFilters` have been defined (or if `supportsConfigurationDoneRequest` is not true)\n- client sends other future configuration requests\n- client sends one `configurationDone` request to indicate the end of the configuration.", "properties": { "event": { "type": "string", @@ -181,7 +182,7 @@ "StoppedEvent": { "allOf": [ { "$ref": "#/definitions/Event" }, { "type": "object", - "description": "The event indicates that the execution of the debuggee has stopped due to some condition.\nThis can be caused by a break point previously set, a stepping request has completed, by executing a debugger statement etc.", + "description": "The event indicates that the execution of the debuggee has stopped due to some condition.\nThis can be caused by a breakpoint previously set, a stepping request has completed, by executing a debugger statement etc.", "properties": { "event": { "type": "string", @@ -192,12 +193,12 @@ "properties": { "reason": { "type": "string", - "description": "The reason for the event.\nFor backward compatibility this string is shown in the UI if the 'description' attribute is missing (but it must not be translated).", + "description": "The reason for the event.\nFor backward compatibility this string is shown in the UI if the `description` attribute is missing (but it must not be translated).", "_enum": [ "step", "breakpoint", "exception", "pause", "entry", "goto", "function breakpoint", "data breakpoint", "instruction breakpoint" ] }, "description": { "type": "string", - "description": "The full reason for the event, e.g. 'Paused on exception'. This string is shown in the UI as is and must be translated." + "description": "The full reason for the event, e.g. 'Paused on exception'. This string is shown in the UI as is and can be translated." }, "threadId": { "type": "integer", @@ -205,22 +206,22 @@ }, "preserveFocusHint": { "type": "boolean", - "description": "A value of true hints to the frontend that this event should not change the focus." + "description": "A value of true hints to the client that this event should not change the focus." }, "text": { "type": "string", - "description": "Additional information. E.g. if reason is 'exception', text contains the exception name. This string is shown in the UI." + "description": "Additional information. E.g. if reason is `exception`, text contains the exception name. This string is shown in the UI." }, "allThreadsStopped": { "type": "boolean", - "description": "If 'allThreadsStopped' is true, a debug adapter can announce that all threads have stopped.\n- The client should use this information to enable that all threads can be expanded to access their stacktraces.\n- If the attribute is missing or false, only the thread with the given threadId can be expanded." + "description": "If `allThreadsStopped` is true, a debug adapter can announce that all threads have stopped.\n- The client should use this information to enable that all threads can be expanded to access their stacktraces.\n- If the attribute is missing or false, only the thread with the given `threadId` can be expanded." }, "hitBreakpointIds": { "type": "array", "items": { "type": "integer" }, - "description": "Ids of the breakpoints that triggered the event. In most cases there will be only a single breakpoint but here are some examples for multiple breakpoints:\n- Different types of breakpoints map to the same location.\n- Multiple source breakpoints get collapsed to the same instruction by the compiler/runtime.\n- Multiple function breakpoints with different function names map to the same location." + "description": "Ids of the breakpoints that triggered the event. In most cases there is only a single breakpoint but here are some examples for multiple breakpoints:\n- Different types of breakpoints map to the same location.\n- Multiple source breakpoints get collapsed to the same instruction by the compiler/runtime.\n- Multiple function breakpoints with different function names map to the same location." } }, "required": [ "reason" ] @@ -233,7 +234,7 @@ "ContinuedEvent": { "allOf": [ { "$ref": "#/definitions/Event" }, { "type": "object", - "description": "The event indicates that the execution of the debuggee has continued.\nPlease 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'.\nIt is only necessary to send a 'continued' event if there was no previous request that implied this.", + "description": "The event indicates that the execution of the debuggee has continued.\nPlease 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`.\nIt is only necessary to send a `continued` event if there was no previous request that implied this.", "properties": { "event": { "type": "string", @@ -248,7 +249,7 @@ }, "allThreadsContinued": { "type": "boolean", - "description": "If 'allThreadsContinued' is true, a debug adapter can announce that all threads have continued." + "description": "If `allThreadsContinued` is true, a debug adapter can announce that all threads have continued." } }, "required": [ "threadId" ] @@ -296,7 +297,7 @@ "properties": { "restart": { "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ], - "description": "A debug adapter may set 'restart' to true (or to an arbitrary object) to request that the front end restarts the session.\nThe value is not interpreted by the client and passed unmodified as an attribute '__restart' to the 'launch' and 'attach' requests." + "description": "A debug adapter may set `restart` to true (or to an arbitrary object) to request that the client restarts the session.\nThe value is not interpreted by the client and passed unmodified as an attribute `__restart` to the `launch` and `attach` requests." } } } @@ -348,8 +349,15 @@ "properties": { "category": { "type": "string", - "description": "The output category. If not specified, 'console' is assumed.", - "_enum": [ "console", "stdout", "stderr", "telemetry" ] + "description": "The output category. If not specified or if the category is not understood by the client, `console` is assumed.", + "_enum": [ "console", "important", "stdout", "stderr", "telemetry" ], + "enumDescriptions": [ + "Show the output in the client's default message UI, e.g. a 'debug console'. This category should only be used for informational output from the debugger (as opposed to the debuggee).", + "A hint for the client to show the output in the client's UI for important and highly visible information, e.g. as a popup notification. This category should only be used for important messages from the debugger (as opposed to the debuggee). Since this category value is a hint, clients might ignore the hint and assume the `console` category.", + "Show the output as normal program output from the debuggee.", + "Show the output as error program output from the debuggee.", + "Send the output to telemetry instead of showing it to the user." + ] }, "output": { "type": "string", @@ -360,30 +368,30 @@ "description": "Support for keeping an output log organized by grouping related messages.", "enum": [ "start", "startCollapsed", "end" ], "enumDescriptions": [ - "Start a new group in expanded mode. Subsequent output events are members of the group and should be shown indented.\nThe 'output' attribute becomes the name of the group and is not indented.", - "Start a new group in collapsed mode. Subsequent output events are members of the group and should be shown indented (as soon as the group is expanded).\nThe 'output' attribute becomes the name of the group and is not indented.", - "End the current group and decreases the indentation of subsequent output events.\nA non empty 'output' attribute is shown as the unindented end of the group." + "Start a new group in expanded mode. Subsequent output events are members of the group and should be shown indented.\nThe `output` attribute becomes the name of the group and is not indented.", + "Start a new group in collapsed mode. Subsequent output events are members of the group and should be shown indented (as soon as the group is expanded).\nThe `output` attribute becomes the name of the group and is not indented.", + "End the current group and decrease the indentation of subsequent output events.\nA non-empty `output` attribute is shown as the unindented end of the group." ] }, "variablesReference": { "type": "integer", - "description": "If an attribute 'variablesReference' exists and its value is > 0, the output contains objects which can be retrieved by passing 'variablesReference' to the 'variables' request. The value should be less than or equal to 2147483647 (2^31-1)." + "description": "If an attribute `variablesReference` exists and its value is > 0, the output contains objects which can be retrieved by passing `variablesReference` to the `variables` request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details." }, "source": { "$ref": "#/definitions/Source", - "description": "An optional source location where the output was produced." + "description": "The source location where the output was produced." }, "line": { "type": "integer", - "description": "An optional source location line where the output was produced." + "description": "The source location's line where the output was produced." }, "column": { "type": "integer", - "description": "An optional source location column where the output was produced." + "description": "The position in `line` where the output was produced. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." }, "data": { "type": [ "array", "boolean", "integer", "null", "number" , "object", "string" ], - "description": "Optional data to report. For the 'telemetry' category the data will be sent to telemetry, for the other categories the data is shown in JSON format." + "description": "Additional data to report. For the `telemetry` category the data is sent to telemetry, for the other categories the data is shown in JSON format." } }, "required": ["output"] @@ -412,7 +420,7 @@ }, "breakpoint": { "$ref": "#/definitions/Breakpoint", - "description": "The 'id' attribute is used to find the target breakpoint and the other attributes are used as the new values." + "description": "The `id` attribute is used to find the target breakpoint, the other attributes are used as the new values." } }, "required": [ "reason", "breakpoint" ] @@ -441,7 +449,7 @@ }, "module": { "$ref": "#/definitions/Module", - "description": "The new, changed, or removed module. In case of 'removed' only the module id is used." + "description": "The new, changed, or removed module. In case of `removed` only the module id is used." } }, "required": [ "reason", "module" ] @@ -500,7 +508,7 @@ }, "systemProcessId": { "type": "integer", - "description": "The system process id of the debugged process. This property will be missing for non-system processes." + "description": "The system process id of the debugged process. This property is missing for non-system processes." }, "isLocalProcess": { "type": "boolean", @@ -532,7 +540,7 @@ "CapabilitiesEvent": { "allOf": [ { "$ref": "#/definitions/Event" }, { "type": "object", - "description": "The event indicates that one or more capabilities have changed.\nSince the capabilities are dependent on the frontend and its UI, it might not be possible to change that at random times (or too late).\nConsequently 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.\nOnly changed capabilities need to be included, all other capabilities keep their values.", + "description": "The event indicates that one or more capabilities have changed.\nSince the capabilities are dependent on the client and its UI, it might not be possible to change that at random times (or too late).\nConsequently this event has a hint characteristic: a client can only be expected to make a 'best effort' in honoring individual capabilities but there are no guarantees.\nOnly changed capabilities need to be included, all other capabilities keep their values.", "properties": { "event": { "type": "string", @@ -556,7 +564,7 @@ "ProgressStartEvent": { "allOf": [ { "$ref": "#/definitions/Event" }, { "type": "object", - "description": "The event signals that a long running operation is about to start and\nprovides additional information for the client to set up a corresponding progress and cancellation UI.\nThe client is free to delay the showing of the UI in order to reduce flicker.\nThis event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.", + "description": "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.\nThe client is free to delay the showing of the UI in order to reduce flicker.\nThis event should only be sent if the corresponding capability `supportsProgressReporting` is true.", "properties": { "event": { "type": "string", @@ -567,27 +575,27 @@ "properties": { "progressId": { "type": "string", - "description": "An ID that must be used in subsequent 'progressUpdate' and 'progressEnd' events to make them refer to the same progress reporting.\nIDs must be unique within a debug session." + "description": "An ID that can be used in subsequent `progressUpdate` and `progressEnd` events to make them refer to the same progress reporting.\nIDs must be unique within a debug session." }, "title": { "type": "string", - "description": "Mandatory (short) title of the progress reporting. Shown in the UI to describe the long running operation." + "description": "Short title of the progress reporting. Shown in the UI to describe the long running operation." }, "requestId": { "type": "integer", - "description": "The request ID that this progress report is related to. If specified a debug adapter is expected to emit\nprogress events for the long running request until the request has been either completed or cancelled.\nIf the request ID is omitted, the progress report is assumed to be related to some general activity of the debug adapter." + "description": "The request ID that this progress report is related to. If specified a debug adapter is expected to emit progress events for the long running request until the request has been either completed or cancelled.\nIf the request ID is omitted, the progress report is assumed to be related to some general activity of the debug adapter." }, "cancellable": { "type": "boolean", - "description": "If true, the request that reports progress may be canceled with a 'cancel' request.\nSo this property basically controls whether the client should use UX that supports cancellation.\nClients that don't support cancellation are allowed to ignore the setting." + "description": "If true, the request that reports progress may be cancelled with a `cancel` request.\nSo this property basically controls whether the client should use UX that supports cancellation.\nClients that don't support cancellation are allowed to ignore the setting." }, "message": { "type": "string", - "description": "Optional, more detailed progress message." + "description": "More detailed progress message." }, "percentage": { "type": "number", - "description": "Optional progress percentage to display (value range: 0 to 100). If omitted no percentage will be shown." + "description": "Progress percentage to display (value range: 0 to 100). If omitted no percentage is shown." } }, "required": [ "progressId", "title" ] @@ -600,7 +608,7 @@ "ProgressUpdateEvent": { "allOf": [ { "$ref": "#/definitions/Event" }, { "type": "object", - "description": "The event signals that the progress reporting needs to updated with a new message and/or percentage.\nThe client does not have to update the UI immediately, but the clients needs to keep track of the message and/or percentage values.\nThis event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.", + "description": "The event signals that the progress reporting needs to be updated with a new message and/or percentage.\nThe client does not have to update the UI immediately, but the clients needs to keep track of the message and/or percentage values.\nThis event should only be sent if the corresponding capability `supportsProgressReporting` is true.", "properties": { "event": { "type": "string", @@ -611,15 +619,15 @@ "properties": { "progressId": { "type": "string", - "description": "The ID that was introduced in the initial 'progressStart' event." + "description": "The ID that was introduced in the initial `progressStart` event." }, "message": { "type": "string", - "description": "Optional, more detailed progress message. If omitted, the previous message (if any) is used." + "description": "More detailed progress message. If omitted, the previous message (if any) is used." }, "percentage": { "type": "number", - "description": "Optional progress percentage to display (value range: 0 to 100). If omitted no percentage will be shown." + "description": "Progress percentage to display (value range: 0 to 100). If omitted no percentage is shown." } }, "required": [ "progressId" ] @@ -632,7 +640,7 @@ "ProgressEndEvent": { "allOf": [ { "$ref": "#/definitions/Event" }, { "type": "object", - "description": "The event signals the end of the progress reporting with an optional final message.\nThis event should only be sent if the client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.", + "description": "The event signals the end of the progress reporting with a final message.\nThis event should only be sent if the corresponding capability `supportsProgressReporting` is true.", "properties": { "event": { "type": "string", @@ -643,11 +651,11 @@ "properties": { "progressId": { "type": "string", - "description": "The ID that was introduced in the initial 'ProgressStartEvent'." + "description": "The ID that was introduced in the initial `ProgressStartEvent`." }, "message": { "type": "string", - "description": "Optional, more detailed progress message. If omitted, the previous message (if any) is used." + "description": "More detailed progress message. If omitted, the previous message (if any) is used." } }, "required": [ "progressId" ] @@ -660,7 +668,7 @@ "InvalidatedEvent": { "allOf": [ { "$ref": "#/definitions/Event" }, { "type": "object", - "description": "This event signals that some state in the debug adapter has changed and requires that the client needs to re-render the data snapshot previously requested.\nDebug adapters do not have to emit this event for runtime changes like stopped or thread events because in that case the client refetches the new state anyway. But the event can be used for example to refresh the UI after rendering formatting has changed in the debug adapter.\nThis event should only be sent if the debug adapter has received a value true for the 'supportsInvalidatedEvent' capability of the 'initialize' request.", + "description": "This event signals that some state in the debug adapter has changed and requires that the client needs to re-render the data snapshot previously requested.\nDebug adapters do not have to emit this event for runtime changes like stopped or thread events because in that case the client refetches the new state anyway. But the event can be used for example to refresh the UI after rendering formatting has changed in the debug adapter.\nThis event should only be sent if the corresponding capability `supportsInvalidatedEvent` is true.", "properties": { "event": { "type": "string", @@ -671,7 +679,7 @@ "properties": { "areas": { "type": "array", - "description": "Optional set of logical areas that got invalidated. This property has a hint characteristic: a client can only be expected to make a 'best effort' in honouring the areas but there are no guarantees. If this property is missing, empty, or if values are not understand the client should assume a single value 'all'.", + "description": "Set of logical areas that got invalidated. This property has a hint characteristic: a client can only be expected to make a 'best effort' in honoring the areas but there are no guarantees. If this property is missing, empty, or if values are not understood, the client should assume a single value `all`.", "items": { "$ref": "#/definitions/InvalidatedAreas" } @@ -682,7 +690,7 @@ }, "stackFrameId": { "type": "integer", - "description": "If specified, the client only needs to refetch data related to this stack frame (and the 'threadId' is ignored)." + "description": "If specified, the client only needs to refetch data related to this stack frame (and the `threadId` is ignored)." } } } @@ -691,11 +699,43 @@ }] }, + "MemoryEvent": { + "allOf": [ { "$ref": "#/definitions/Event" }, { + "type": "object", + "description": "This event indicates that some memory range has been updated. It should only be sent if the corresponding capability `supportsMemoryEvent` is true.\nClients typically react to the event by re-issuing a `readMemory` request if they show the memory identified by the `memoryReference` and if the updated memory range overlaps the displayed range. Clients should not make assumptions how individual memory references relate to each other, so they should not assume that they are part of a single continuous address range and might overlap.\nDebug adapters can use this event to indicate that the contents of a memory range has changed due to some other request like `setVariable` or `setExpression`. Debug adapters are not expected to emit this event for each and every memory change of a running program, because that information is typically not available from debuggers and it would flood clients with too many events.", + "properties": { + "event": { + "type": "string", + "enum": [ "memory" ] + }, + "body": { + "type": "object", + "properties": { + "memoryReference": { + "type": "string", + "description": "Memory reference of a memory range that has been updated." + }, + "offset": { + "type": "integer", + "description": "Starting offset in bytes where memory has been updated. Can be negative." + }, + "count": { + "type": "integer", + "description": "Number of bytes updated." + } + }, + "required": [ "memoryReference", "offset", "count" ] + } + }, + "required": [ "event", "body" ] + }] + }, + "RunInTerminalRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", "title": "Reverse Requests", - "description": "This optional request is sent from the debug adapter to the client to run a command in a terminal.\nThis is typically used to launch the debuggee in a terminal provided by the client.\nThis request should only be called if the client has passed the value true for the 'supportsRunInTerminalRequest' capability of the 'initialize' request.", + "description": "This request is sent from the debug adapter to the client to run a command in a terminal.\nThis is typically used to launch the debuggee in a terminal provided by the client.\nThis request should only be called if the corresponding client capability `supportsRunInTerminalRequest` is true.\nClient implementations of `runInTerminal` are free to run the command however they choose including issuing the command to a command line interpreter (aka 'shell'). Argument strings passed to the `runInTerminal` request must arrive verbatim in the command to be run. As a consequence, clients which use a shell are responsible for escaping any special shell characters in the argument strings to prevent them from being interpreted (and modified) by the shell.\nSome users may wish to take advantage of shell processing in the argument strings. For clients which implement `runInTerminal` using an intermediary shell, the `argsCanBeInterpretedByShell` property can be set to true. In this case the client is requested not to escape any special shell characters in the argument strings.", "properties": { "command": { "type": "string", @@ -710,16 +750,16 @@ }, "RunInTerminalRequestArguments": { "type": "object", - "description": "Arguments for 'runInTerminal' request.", + "description": "Arguments for `runInTerminal` request.", "properties": { "kind": { "type": "string", "enum": [ "integrated", "external" ], - "description": "What kind of terminal to launch." + "description": "What kind of terminal to launch. Defaults to `integrated` if not specified." }, "title": { "type": "string", - "description": "Optional title of the terminal." + "description": "Title of the terminal." }, "cwd": { "type": "string", @@ -737,8 +777,12 @@ "description": "Environment key-value pairs that are added to or removed from the default environment.", "additionalProperties": { "type": [ "string", "null" ], - "description": "Proper values must be strings. A value of 'null' removes the variable from the environment." + "description": "A string is a proper value for an environment variable. The value `null` removes the variable from the environment." } + }, + "argsCanBeInterpretedByShell": { + "type": "boolean", + "description": "This property should only be set if the corresponding capability `supportsArgsCanBeInterpretedByShell` is true. If the client uses an intermediary shell to launch the application, then the client must not attempt to escape characters with special meanings for the shell. The user is fully responsible for escaping as needed and that arguments using special characters may not be portable across shells." } }, "required": [ "args", "cwd" ] @@ -746,7 +790,7 @@ "RunInTerminalResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'runInTerminal' request.", + "description": "Response to `runInTerminal` request.", "properties": { "body": { "type": "object", @@ -765,12 +809,72 @@ "required": [ "body" ] }] }, + "StartDebuggingRequest": { + "allOf": [ + { + "$ref": "#/definitions/Request" + }, + { + "type": "object", + "description": "This request is sent from the debug adapter to the client to start a new debug session of the same type as the caller.\nThis request should only be sent if the corresponding client capability `supportsStartDebuggingRequest` is true.\nA client implementation of `startDebugging` should start a new debug session (of the same type as the caller) in the same way that the caller's session was started. If the client supports hierarchical debug sessions, the newly created session can be treated as a child of the caller session.", + "properties": { + "command": { + "type": "string", + "enum": [ + "startDebugging" + ] + }, + "arguments": { + "$ref": "#/definitions/StartDebuggingRequestArguments" + } + }, + "required": [ + "command", + "arguments" + ] + } + ] + }, + "StartDebuggingRequestArguments": { + "type": "object", + "description": "Arguments for `startDebugging` request.", + "properties": { + "configuration": { + "type": "object", + "additionalProperties": true, + "description": "Arguments passed to the new debug session. The arguments must only contain properties understood by the `launch` or `attach` requests of the debug adapter and they must not contain any client-specific properties (e.g. `type`) or client-specific features (e.g. substitutable 'variables')." + }, + "request": { + "type": "string", + "enum": [ + "launch", + "attach" + ], + "description": "Indicates whether the new debug session should be started with a `launch` or `attach` request." + } + }, + "required": [ + "configuration", + "request" + ] + }, + "StartDebuggingResponse": { + "allOf": [ + { + "$ref": "#/definitions/Response" + }, + { + "type": "object", + "description": "Response to `startDebugging` request. This is just an acknowledgement, so no body field is required." + } + ] + }, "InitializeRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", "title": "Requests", - "description": "The 'initialize' request is sent as the first request from the client to the debug adapter\nin order to configure it with client capabilities and to retrieve capabilities from the debug adapter.\nUntil the debug adapter has responded to with an 'initialize' response, the client must not send any additional requests or events to the debug adapter.\nIn addition the debug adapter is not allowed to send any requests or events to the client until it has responded with an 'initialize' response.\nThe 'initialize' request may only be sent once.", + "description": "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.\nUntil the debug adapter has responded with an `initialize` response, the client must not send any additional requests or events to the debug adapter.\nIn addition the debug adapter is not allowed to send any requests or events to the client until it has responded with an `initialize` response.\nThe `initialize` request may only be sent once.", "properties": { "command": { "type": "string", @@ -785,15 +889,15 @@ }, "InitializeRequestArguments": { "type": "object", - "description": "Arguments for 'initialize' request.", + "description": "Arguments for `initialize` request.", "properties": { "clientID": { "type": "string", - "description": "The ID of the (frontend) client using this adapter." + "description": "The ID of the client using this adapter." }, "clientName": { "type": "string", - "description": "The human readable name of the (frontend) client using this adapter." + "description": "The human-readable name of the client using this adapter." }, "adapterID": { "type": "string", @@ -801,7 +905,7 @@ }, "locale": { "type": "string", - "description": "The ISO-639 locale of the (frontend) client using this adapter, e.g. en-US or de-CH." + "description": "The ISO-639 locale of the client using this adapter, e.g. en-US or de-CH." }, "linesStartAt1": { "type": "boolean", @@ -814,11 +918,11 @@ "pathFormat": { "type": "string", "_enum": [ "path", "uri" ], - "description": "Determines in what format paths are specified. The default is 'path', which is the native format." + "description": "Determines in what format paths are specified. The default is `path`, which is the native format." }, "supportsVariableType": { "type": "boolean", - "description": "Client supports the optional type attribute for variables." + "description": "Client supports the `type` attribute for variables." }, "supportsVariablePaging": { "type": "boolean", @@ -826,7 +930,7 @@ }, "supportsRunInTerminalRequest": { "type": "boolean", - "description": "Client supports the runInTerminal request." + "description": "Client supports the `runInTerminal` request." }, "supportsMemoryReferences": { "type": "boolean", @@ -838,7 +942,19 @@ }, "supportsInvalidatedEvent": { "type": "boolean", - "description": "Client supports the invalidated event." + "description": "Client supports the `invalidated` event." + }, + "supportsMemoryEvent": { + "type": "boolean", + "description": "Client supports the `memory` event." + }, + "supportsArgsCanBeInterpretedByShell": { + "type": "boolean", + "description": "Client supports the `argsCanBeInterpretedByShell` attribute on the `runInTerminal` request." + }, + "supportsStartDebuggingRequest": { + "type": "boolean", + "description": "Client supports the `startDebugging` request." } }, "required": [ "adapterID" ] @@ -846,7 +962,7 @@ "InitializeResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'initialize' request.", + "description": "Response to `initialize` request.", "properties": { "body": { "$ref": "#/definitions/Capabilities", @@ -859,7 +975,7 @@ "ConfigurationDoneRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "This optional request indicates that the client has finished initialization of the debug adapter.\nSo it is the last request in the sequence of configuration requests (which was started by the 'initialized' event).\nClients should only call this request if the capability 'supportsConfigurationDoneRequest' is true.", + "description": "This request indicates that the client has finished initialization of the debug adapter.\nSo it is the last request in the sequence of configuration requests (which was started by the `initialized` event).\nClients should only call this request if the corresponding capability `supportsConfigurationDoneRequest` is true.", "properties": { "command": { "type": "string", @@ -874,19 +990,19 @@ }, "ConfigurationDoneArguments": { "type": "object", - "description": "Arguments for 'configurationDone' request." + "description": "Arguments for `configurationDone` request." }, "ConfigurationDoneResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'configurationDone' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `configurationDone` request. This is just an acknowledgement, so no body field is required." }] }, "LaunchRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "This launch request is sent from the client to the debug adapter to start the debuggee with or without debugging (if 'noDebug' is true).\nSince launching is debugger/runtime specific, the arguments for this request are not part of this specification.", + "description": "This launch request is sent from the client to the debug adapter to start the debuggee with or without debugging (if `noDebug` is true).\nSince launching is debugger/runtime specific, the arguments for this request are not part of this specification.", "properties": { "command": { "type": "string", @@ -901,29 +1017,29 @@ }, "LaunchRequestArguments": { "type": "object", - "description": "Arguments for 'launch' request. Additional attributes are implementation specific.", + "description": "Arguments for `launch` request. Additional attributes are implementation specific.", "properties": { "noDebug": { "type": "boolean", - "description": "If noDebug is true the launch request should launch the program without enabling debugging." + "description": "If true, the launch request should launch the program without enabling debugging." }, "__restart": { "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ], - "description": "Optional data from the previous, restarted session.\nThe data is sent as the 'restart' attribute of the 'terminated' event.\nThe client should leave the data intact." + "description": "Arbitrary data from the previous, restarted session.\nThe data is sent as the `restart` attribute of the `terminated` event.\nThe client should leave the data intact." } } }, "LaunchResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'launch' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `launch` request. This is just an acknowledgement, so no body field is required." }] }, "AttachRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The attach request is sent from the client to the debug adapter to attach to a debuggee that is already running.\nSince attaching is debugger/runtime specific, the arguments for this request are not part of this specification.", + "description": "The `attach` request is sent from the client to the debug adapter to attach to a debuggee that is already running.\nSince attaching is debugger/runtime specific, the arguments for this request are not part of this specification.", "properties": { "command": { "type": "string", @@ -938,25 +1054,25 @@ }, "AttachRequestArguments": { "type": "object", - "description": "Arguments for 'attach' request. Additional attributes are implementation specific.", + "description": "Arguments for `attach` request. Additional attributes are implementation specific.", "properties": { "__restart": { "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ], - "description": "Optional data from the previous, restarted session.\nThe data is sent as the 'restart' attribute of the 'terminated' event.\nThe client should leave the data intact." + "description": "Arbitrary data from the previous, restarted session.\nThe data is sent as the `restart` attribute of the `terminated` event.\nThe client should leave the data intact." } } }, "AttachResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'attach' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `attach` request. This is just an acknowledgement, so no body field is required." }] }, "RestartRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Restarts a debug session. Clients should only call this request if the capability 'supportsRestartRequest' is true.\nIf 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.", + "description": "Restarts a debug session. Clients should only call this request if the corresponding capability `supportsRestartRequest` is true.\nIf the capability is missing or has the value false, a typical client emulates `restart` by terminating the debug adapter first and then launching it anew.", "properties": { "command": { "type": "string", @@ -971,28 +1087,28 @@ }, "RestartArguments": { "type": "object", - "description": "Arguments for 'restart' request.", + "description": "Arguments for `restart` request.", "properties": { "arguments": { "oneOf": [ { "$ref": "#/definitions/LaunchRequestArguments" }, { "$ref": "#/definitions/AttachRequestArguments" } ], - "description": "The latest version of the 'launch' or 'attach' configuration." + "description": "The latest version of the `launch` or `attach` configuration." } } }, "RestartResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'restart' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `restart` request. This is just an acknowledgement, so no body field is required." }] }, "DisconnectRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The 'disconnect' request is sent from the client to the debug adapter in order to stop debugging.\nIt asks the debug adapter to disconnect from the debuggee and to terminate the debug adapter.\nIf the debuggee has been started with the 'launch' request, the 'disconnect' request terminates the debuggee.\nIf the 'attach' request was used to connect to the debuggee, 'disconnect' does not terminate the debuggee.\nThis behavior can be controlled with the 'terminateDebuggee' argument (if supported by the debug adapter).", + "description": "The `disconnect` request asks the debug adapter to disconnect from the debuggee (thus ending the debug session) and then to shut down itself (the debug adapter).\nIn addition, the debug adapter must terminate the debuggee if it was started with the `launch` request. If an `attach` request was used to connect to the debuggee, then the debug adapter must not terminate the debuggee.\nThis implicit behavior of when to terminate the debuggee can be overridden with the `terminateDebuggee` argument (which is only supported by a debug adapter if the corresponding capability `supportTerminateDebuggee` is true).", "properties": { "command": { "type": "string", @@ -1007,33 +1123,33 @@ }, "DisconnectArguments": { "type": "object", - "description": "Arguments for 'disconnect' request.", + "description": "Arguments for `disconnect` request.", "properties": { "restart": { "type": "boolean", - "description": "A value of true indicates that this 'disconnect' request is part of a restart sequence." + "description": "A value of true indicates that this `disconnect` request is part of a restart sequence." }, "terminateDebuggee": { "type": "boolean", - "description": "Indicates whether the debuggee should be terminated when the debugger is disconnected.\nIf unspecified, the debug adapter is free to do whatever it thinks is best.\nThe attribute is only honored by a debug adapter if the capability 'supportTerminateDebuggee' is true." + "description": "Indicates whether the debuggee should be terminated when the debugger is disconnected.\nIf unspecified, the debug adapter is free to do whatever it thinks is best.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportTerminateDebuggee` is true." }, "suspendDebuggee": { "type": "boolean", - "description": "Indicates whether the debuggee should stay suspended when the debugger is disconnected.\nIf unspecified, the debuggee should resume execution.\nThe attribute is only honored by a debug adapter if the capability 'supportSuspendDebuggee' is true." + "description": "Indicates whether the debuggee should stay suspended when the debugger is disconnected.\nIf unspecified, the debuggee should resume execution.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportSuspendDebuggee` is true." } } }, "DisconnectResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'disconnect' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `disconnect` request. This is just an acknowledgement, so no body field is required." }] }, "TerminateRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The 'terminate' request is sent from the client to the debug adapter in order to give the debuggee a chance for terminating itself.\nClients should only call this request if the capability 'supportsTerminateRequest' is true.", + "description": "The `terminate` request is sent from the client to the debug adapter in order to shut down the debuggee gracefully. Clients should only call this request if the capability `supportsTerminateRequest` is true.\nTypically a debug adapter implements `terminate` by sending a software signal which the debuggee intercepts in order to clean things up properly before terminating itself.\nPlease note that this request does not directly affect the state of the debug session: if the debuggee decides to veto the graceful shutdown for any reason by not terminating itself, then the debug session just continues.\nClients can surface the `terminate` request as an explicit command or they can integrate it into a two stage Stop command that first sends `terminate` to request a graceful shutdown, and if that fails uses `disconnect` for a forceful shutdown.", "properties": { "command": { "type": "string", @@ -1048,25 +1164,25 @@ }, "TerminateArguments": { "type": "object", - "description": "Arguments for 'terminate' request.", + "description": "Arguments for `terminate` request.", "properties": { "restart": { "type": "boolean", - "description": "A value of true indicates that this 'terminate' request is part of a restart sequence." + "description": "A value of true indicates that this `terminate` request is part of a restart sequence." } } }, "TerminateResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'terminate' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `terminate` request. This is just an acknowledgement, so no body field is required." }] }, "BreakpointLocationsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The 'breakpointLocations' request returns all possible locations for source breakpoints in a given range.\nClients should only call this request if the capability 'supportsBreakpointLocationsRequest' is true.", + "description": "The `breakpointLocations` request returns all possible locations for source breakpoints in a given range.\nClients should only call this request if the corresponding capability `supportsBreakpointLocationsRequest` is true.", "properties": { "command": { "type": "string", @@ -1082,11 +1198,11 @@ }, "BreakpointLocationsArguments": { "type": "object", - "description": "Arguments for 'breakpointLocations' request.", + "description": "Arguments for `breakpointLocations` request.", "properties": { "source": { "$ref": "#/definitions/Source", - "description": "The source location of the breakpoints; either 'source.path' or 'source.reference' must be specified." + "description": "The source location of the breakpoints; either `source.path` or `source.reference` must be specified." }, "line": { "type": "integer", @@ -1094,15 +1210,15 @@ }, "column": { "type": "integer", - "description": "Optional start column of range to search possible breakpoint locations in. If no start column is given, the first column in the start line is assumed." + "description": "Start position within `line` to search possible breakpoint locations in. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based. If no column is given, the first position in the start line is assumed." }, "endLine": { "type": "integer", - "description": "Optional end line of range to search possible breakpoint locations in. If no end line is given, then the end line is assumed to be the start line." + "description": "End line of range to search possible breakpoint locations in. If no end line is given, then the end line is assumed to be the start line." }, "endColumn": { "type": "integer", - "description": "Optional end column of range to search possible breakpoint locations in. If no end column is given, then it is assumed to be in the last column of the end line." + "description": "End position within `endLine` to search possible breakpoint locations in. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based. If no end column is given, the last position in the end line is assumed." } }, "required": [ "source", "line" ] @@ -1110,7 +1226,7 @@ "BreakpointLocationsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'breakpointLocations' request.\nContains possible locations for source breakpoints.", + "description": "Response to `breakpointLocations` request.\nContains possible locations for source breakpoints.", "properties": { "body": { "type": "object", @@ -1133,7 +1249,7 @@ "SetBreakpointsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Sets multiple breakpoints for a single source and clears all previous breakpoints in that source.\nTo clear all breakpoint for a source, specify an empty array.\nWhen a breakpoint is hit, a 'stopped' event (with reason 'breakpoint') is generated.", + "description": "Sets multiple breakpoints for a single source and clears all previous breakpoints in that source.\nTo clear all breakpoint for a source, specify an empty array.\nWhen a breakpoint is hit, a `stopped` event (with reason `breakpoint`) is generated.", "properties": { "command": { "type": "string", @@ -1148,11 +1264,11 @@ }, "SetBreakpointsArguments": { "type": "object", - "description": "Arguments for 'setBreakpoints' request.", + "description": "Arguments for `setBreakpoints` request.", "properties": { "source": { "$ref": "#/definitions/Source", - "description": "The source location of the breakpoints; either 'source.path' or 'source.reference' must be specified." + "description": "The source location of the breakpoints; either `source.path` or `source.sourceReference` must be specified." }, "breakpoints": { "type": "array", @@ -1178,7 +1294,7 @@ "SetBreakpointsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'setBreakpoints' request.\nReturned is information about each breakpoint created by this request.\nThis includes the actual code location and whether the breakpoint could be verified.\nThe breakpoints returned are in the same order as the elements of the 'breakpoints'\n(or the deprecated 'lines') array in the arguments.", + "description": "Response to `setBreakpoints` request.\nReturned is information about each breakpoint created by this request.\nThis includes the actual code location and whether the breakpoint could be verified.\nThe breakpoints returned are in the same order as the elements of the `breakpoints`\n(or the deprecated `lines`) array in the arguments.", "properties": { "body": { "type": "object", @@ -1188,7 +1304,7 @@ "items": { "$ref": "#/definitions/Breakpoint" }, - "description": "Information about the breakpoints.\nThe array elements are in the same order as the elements of the 'breakpoints' (or the deprecated 'lines') array in the arguments." + "description": "Information about the breakpoints.\nThe array elements are in the same order as the elements of the `breakpoints` (or the deprecated `lines`) array in the arguments." } }, "required": [ "breakpoints" ] @@ -1201,7 +1317,7 @@ "SetFunctionBreakpointsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Replaces all existing function breakpoints with new function breakpoints.\nTo clear all function breakpoints, specify an empty array.\nWhen a function breakpoint is hit, a 'stopped' event (with reason 'function breakpoint') is generated.\nClients should only call this request if the capability 'supportsFunctionBreakpoints' is true.", + "description": "Replaces all existing function breakpoints with new function breakpoints.\nTo clear all function breakpoints, specify an empty array.\nWhen a function breakpoint is hit, a `stopped` event (with reason `function breakpoint`) is generated.\nClients should only call this request if the corresponding capability `supportsFunctionBreakpoints` is true.", "properties": { "command": { "type": "string", @@ -1216,7 +1332,7 @@ }, "SetFunctionBreakpointsArguments": { "type": "object", - "description": "Arguments for 'setFunctionBreakpoints' request.", + "description": "Arguments for `setFunctionBreakpoints` request.", "properties": { "breakpoints": { "type": "array", @@ -1231,7 +1347,7 @@ "SetFunctionBreakpointsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'setFunctionBreakpoints' request.\nReturned is information about each breakpoint created by this request.", + "description": "Response to `setFunctionBreakpoints` request.\nReturned is information about each breakpoint created by this request.", "properties": { "body": { "type": "object", @@ -1241,7 +1357,7 @@ "items": { "$ref": "#/definitions/Breakpoint" }, - "description": "Information about the breakpoints. The array elements correspond to the elements of the 'breakpoints' array." + "description": "Information about the breakpoints. The array elements correspond to the elements of the `breakpoints` array." } }, "required": [ "breakpoints" ] @@ -1254,7 +1370,7 @@ "SetExceptionBreakpointsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request configures the debuggers response to thrown exceptions.\nIf an exception is configured to break, a 'stopped' event is fired (with reason 'exception').\nClients should only call this request if the capability 'exceptionBreakpointFilters' returns one or more filters.", + "description": "The request configures the debugger's response to thrown exceptions.\nIf an exception is configured to break, a `stopped` event is fired (with reason `exception`).\nClients should only call this request if the corresponding capability `exceptionBreakpointFilters` returns one or more filters.", "properties": { "command": { "type": "string", @@ -1269,28 +1385,28 @@ }, "SetExceptionBreakpointsArguments": { "type": "object", - "description": "Arguments for 'setExceptionBreakpoints' request.", + "description": "Arguments for `setExceptionBreakpoints` request.", "properties": { "filters": { "type": "array", "items": { "type": "string" }, - "description": "Set of exception filters specified by their ID. The set of all possible exception filters is defined by the 'exceptionBreakpointFilters' capability. The 'filter' and 'filterOptions' sets are additive." + "description": "Set of exception filters specified by their ID. The set of all possible exception filters is defined by the `exceptionBreakpointFilters` capability. The `filter` and `filterOptions` sets are additive." }, "filterOptions": { "type": "array", "items": { "$ref": "#/definitions/ExceptionFilterOptions" }, - "description": "Set of exception filters and their options. The set of all possible exception filters is defined by the 'exceptionBreakpointFilters' capability. This attribute is only honored by a debug adapter if the capability 'supportsExceptionFilterOptions' is true. The 'filter' and 'filterOptions' sets are additive." + "description": "Set of exception filters and their options. The set of all possible exception filters is defined by the `exceptionBreakpointFilters` capability. This attribute is only honored by a debug adapter if the corresponding capability `supportsExceptionFilterOptions` is true. The `filter` and `filterOptions` sets are additive." }, "exceptionOptions": { "type": "array", "items": { "$ref": "#/definitions/ExceptionOptions" }, - "description": "Configuration options for selected exceptions.\nThe attribute is only honored by a debug adapter if the capability 'supportsExceptionOptions' is true." + "description": "Configuration options for selected exceptions.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsExceptionOptions` is true." } }, "required": [ "filters" ] @@ -1298,7 +1414,7 @@ "SetExceptionBreakpointsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'setExceptionBreakpoints' request.\nThe response contains an array of Breakpoint objects with information about each exception breakpoint or filter. The Breakpoint objects are in the same order as the elements of the 'filters', 'filterOptions', 'exceptionOptions' arrays given as arguments. If both 'filters' and 'filterOptions' are given, the returned array must start with 'filters' information first, followed by 'filterOptions' information.\nThe mandatory 'verified' property of a Breakpoint object signals whether the exception breakpoint or filter could be successfully created and whether the optional condition or hit count expressions are valid. In case of an error the 'message' property explains the problem. An optional 'id' property can be used to introduce a unique ID for the exception breakpoint or filter so that it can be updated subsequently by sending breakpoint events.\nFor backward compatibility both the 'breakpoints' array and the enclosing 'body' are optional. If these elements are missing a client will not be able to show problems for individual exception breakpoints or filters.", + "description": "Response to `setExceptionBreakpoints` request.\nThe response contains an array of `Breakpoint` objects with information about each exception breakpoint or filter. The `Breakpoint` objects are in the same order as the elements of the `filters`, `filterOptions`, `exceptionOptions` arrays given as arguments. If both `filters` and `filterOptions` are given, the returned array must start with `filters` information first, followed by `filterOptions` information.\nThe `verified` property of a `Breakpoint` object signals whether the exception breakpoint or filter could be successfully created and whether the condition or hit count expressions are valid. In case of an error the `message` property explains the problem. The `id` property can be used to introduce a unique ID for the exception breakpoint or filter so that it can be updated subsequently by sending breakpoint events.\nFor backward compatibility both the `breakpoints` array and the enclosing `body` are optional. If these elements are missing a client is not able to show problems for individual exception breakpoints or filters.", "properties": { "body": { "type": "object", @@ -1308,7 +1424,7 @@ "items": { "$ref": "#/definitions/Breakpoint" }, - "description": "Information about the exception breakpoints or filters.\nThe breakpoints returned are in the same order as the elements of the 'filters', 'filterOptions', 'exceptionOptions' arrays in the arguments. If both 'filters' and 'filterOptions' are given, the returned array must start with 'filters' information first, followed by 'filterOptions' information." + "description": "Information about the exception breakpoints or filters.\nThe breakpoints returned are in the same order as the elements of the `filters`, `filterOptions`, `exceptionOptions` arrays in the arguments. If both `filters` and `filterOptions` are given, the returned array must start with `filters` information first, followed by `filterOptions` information." } } } @@ -1319,7 +1435,7 @@ "DataBreakpointInfoRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Obtains information on a possible data breakpoint that could be set on an expression or variable.\nClients should only call this request if the capability 'supportsDataBreakpoints' is true.", + "description": "Obtains information on a possible data breakpoint that could be set on an expression or variable.\nClients should only call this request if the corresponding capability `supportsDataBreakpoints` is true.", "properties": { "command": { "type": "string", @@ -1334,15 +1450,19 @@ }, "DataBreakpointInfoArguments": { "type": "object", - "description": "Arguments for 'dataBreakpointInfo' request.", + "description": "Arguments for `dataBreakpointInfo` request.", "properties": { "variablesReference": { "type": "integer", - "description": "Reference to the Variable container if the data breakpoint is requested for a child of the container." + "description": "Reference to the variable container if the data breakpoint is requested for a child of the container. The `variablesReference` must have been obtained in the current suspended state. See 'Lifetime of Object References' in the Overview section for details." }, "name": { "type": "string", - "description": "The name of the Variable's child to obtain data breakpoint information for.\nIf variablesReference isn’t provided, this can be an expression." + "description": "The name of the variable's child to obtain data breakpoint information for.\nIf `variablesReference` isn't specified, this can be an expression." + }, + "frameId": { + "type": "integer", + "description": "When `name` is an expression, evaluate it in the scope of this stack frame. If not specified, the expression is evaluated in the global scope. When `variablesReference` is specified, this property has no effect." } }, "required": [ "name" ] @@ -1350,14 +1470,14 @@ "DataBreakpointInfoResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'dataBreakpointInfo' request.", + "description": "Response to `dataBreakpointInfo` request.", "properties": { "body": { "type": "object", "properties": { "dataId": { "type": [ "string", "null" ], - "description": "An identifier for the data on which a data breakpoint can be registered with the setDataBreakpoints request or null if no data breakpoint is available." + "description": "An identifier for the data on which a data breakpoint can be registered with the `setDataBreakpoints` request or null if no data breakpoint is available." }, "description": { "type": "string", @@ -1368,11 +1488,11 @@ "items": { "$ref": "#/definitions/DataBreakpointAccessType" }, - "description": "Optional attribute listing the available access types for a potential data breakpoint. A UI frontend could surface this information." + "description": "Attribute lists the available access types for a potential data breakpoint. A UI client could surface this information." }, "canPersist": { "type": "boolean", - "description": "Optional attribute indicating that a potential data breakpoint could be persisted across sessions." + "description": "Attribute indicates that a potential data breakpoint could be persisted across sessions." } }, "required": [ "dataId", "description" ] @@ -1385,7 +1505,7 @@ "SetDataBreakpointsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Replaces all existing data breakpoints with new data breakpoints.\nTo clear all data breakpoints, specify an empty array.\nWhen a data breakpoint is hit, a 'stopped' event (with reason 'data breakpoint') is generated.\nClients should only call this request if the capability 'supportsDataBreakpoints' is true.", + "description": "Replaces all existing data breakpoints with new data breakpoints.\nTo clear all data breakpoints, specify an empty array.\nWhen a data breakpoint is hit, a `stopped` event (with reason `data breakpoint`) is generated.\nClients should only call this request if the corresponding capability `supportsDataBreakpoints` is true.", "properties": { "command": { "type": "string", @@ -1400,7 +1520,7 @@ }, "SetDataBreakpointsArguments": { "type": "object", - "description": "Arguments for 'setDataBreakpoints' request.", + "description": "Arguments for `setDataBreakpoints` request.", "properties": { "breakpoints": { "type": "array", @@ -1415,7 +1535,7 @@ "SetDataBreakpointsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'setDataBreakpoints' request.\nReturned is information about each breakpoint created by this request.", + "description": "Response to `setDataBreakpoints` request.\nReturned is information about each breakpoint created by this request.", "properties": { "body": { "type": "object", @@ -1425,7 +1545,7 @@ "items": { "$ref": "#/definitions/Breakpoint" }, - "description": "Information about the data breakpoints. The array elements correspond to the elements of the input argument 'breakpoints' array." + "description": "Information about the data breakpoints. The array elements correspond to the elements of the input argument `breakpoints` array." } }, "required": [ "breakpoints" ] @@ -1440,7 +1560,7 @@ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Replaces all existing instruction breakpoints. Typically, instruction breakpoints would be set from a disassembly window. \nTo clear all instruction breakpoints, specify an empty array.\nWhen an instruction breakpoint is hit, a 'stopped' event (with reason 'instruction breakpoint') is generated.\nClients should only call this request if the capability 'supportsInstructionBreakpoints' is true.", + "description": "Replaces all existing instruction breakpoints. Typically, instruction breakpoints would be set from a disassembly window. \nTo clear all instruction breakpoints, specify an empty array.\nWhen an instruction breakpoint is hit, a `stopped` event (with reason `instruction breakpoint`) is generated.\nClients should only call this request if the corresponding capability `supportsInstructionBreakpoints` is true.", "properties": { "command": { "type": "string", @@ -1455,7 +1575,7 @@ }, "SetInstructionBreakpointsArguments": { "type": "object", - "description": "Arguments for 'setInstructionBreakpoints' request", + "description": "Arguments for `setInstructionBreakpoints` request", "properties": { "breakpoints": { "type": "array", @@ -1472,7 +1592,7 @@ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'setInstructionBreakpoints' request", + "description": "Response to `setInstructionBreakpoints` request", "properties": { "body": { "type": "object", @@ -1482,7 +1602,7 @@ "items": { "$ref": "#/definitions/Breakpoint" }, - "description": "Information about the breakpoints. The array elements correspond to the elements of the 'breakpoints' array." + "description": "Information about the breakpoints. The array elements correspond to the elements of the `breakpoints` array." } }, "required": [ "breakpoints" ] @@ -1495,7 +1615,7 @@ "ContinueRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request starts the debuggee to run again.", + "description": "The request resumes execution of all threads. If the debug adapter supports single thread execution (see capability `supportsSingleThreadExecutionRequests`), setting the `singleThread` argument to true resumes only the specified thread. If not all threads were resumed, the `allThreadsContinued` attribute of the response should be set to false.", "properties": { "command": { "type": "string", @@ -1510,11 +1630,15 @@ }, "ContinueArguments": { "type": "object", - "description": "Arguments for 'continue' request.", + "description": "Arguments for `continue` request.", "properties": { "threadId": { "type": "integer", - "description": "Continue execution for the specified thread (if possible).\nIf the backend cannot continue on a single thread but will continue on all threads, it should set the 'allThreadsContinued' attribute in the response to true." + "description": "Specifies the active thread. If the debug adapter supports single thread execution (see `supportsSingleThreadExecutionRequests`) and the argument `singleThread` is true, only the thread with this ID is resumed." + }, + "singleThread": { + "type": "boolean", + "description": "If this flag is true, execution is resumed only for the thread with given `threadId`." } }, "required": [ "threadId" ] @@ -1522,14 +1646,14 @@ "ContinueResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'continue' request.", + "description": "Response to `continue` request.", "properties": { "body": { "type": "object", "properties": { "allThreadsContinued": { "type": "boolean", - "description": "If true, the 'continue' request has ignored the specified thread and continued all threads instead.\nIf this attribute is missing a value of 'true' is assumed for backward compatibility." + "description": "The value true (or a missing property) signals to the client that all threads have been resumed. The value false indicates that not all threads were resumed." } } } @@ -1541,7 +1665,7 @@ "NextRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request starts the debuggee to run again for one step.\nThe debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.", + "description": "The request executes one step (in the given granularity) for the specified thread and allows all other threads to run freely by resuming them.\nIf the debug adapter supports single thread execution (see capability `supportsSingleThreadExecutionRequests`), setting the `singleThread` argument to true prevents other suspended threads from resuming.\nThe debug adapter first sends the response and then a `stopped` event (with reason `step`) after the step has completed.", "properties": { "command": { "type": "string", @@ -1556,15 +1680,19 @@ }, "NextArguments": { "type": "object", - "description": "Arguments for 'next' request.", + "description": "Arguments for `next` request.", "properties": { "threadId": { "type": "integer", - "description": "Execute 'next' for this thread." + "description": "Specifies the thread for which to resume execution for one step (of the given granularity)." + }, + "singleThread": { + "type": "boolean", + "description": "If this flag is true, all other suspended threads are not resumed." }, "granularity": { "$ref": "#/definitions/SteppingGranularity", - "description": "Optional granularity to step. If no granularity is specified, a granularity of 'statement' is assumed." + "description": "Stepping granularity. If no granularity is specified, a granularity of `statement` is assumed." } }, "required": [ "threadId" ] @@ -1572,14 +1700,14 @@ "NextResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'next' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `next` request. This is just an acknowledgement, so no body field is required." }] }, "StepInRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request starts the debuggee to step into a function/method if possible.\nIf it cannot step into a target, 'stepIn' behaves like 'next'.\nThe debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.\nIf there are multiple function/method calls (or other targets) on the source line,\nthe optional argument 'targetId' can be used to control into which target the 'stepIn' should occur.\nThe list of possible targets for a given source line can be retrieved via the 'stepInTargets' request.", + "description": "The request resumes the given thread to step into a function/method and allows all other threads to run freely by resuming them.\nIf the debug adapter supports single thread execution (see capability `supportsSingleThreadExecutionRequests`), setting the `singleThread` argument to true prevents other suspended threads from resuming.\nIf the request cannot step into a target, `stepIn` behaves like the `next` request.\nThe debug adapter first sends the response and then a `stopped` event (with reason `step`) after the step has completed.\nIf there are multiple function/method calls (or other targets) on the source line,\nthe argument `targetId` can be used to control into which target the `stepIn` should occur.\nThe list of possible targets for a given source line can be retrieved via the `stepInTargets` request.", "properties": { "command": { "type": "string", @@ -1594,19 +1722,23 @@ }, "StepInArguments": { "type": "object", - "description": "Arguments for 'stepIn' request.", + "description": "Arguments for `stepIn` request.", "properties": { "threadId": { "type": "integer", - "description": "Execute 'stepIn' for this thread." + "description": "Specifies the thread for which to resume execution for one step-into (of the given granularity)." + }, + "singleThread": { + "type": "boolean", + "description": "If this flag is true, all other suspended threads are not resumed." }, "targetId": { "type": "integer", - "description": "Optional id of the target to step into." + "description": "Id of the target to step into." }, "granularity": { "$ref": "#/definitions/SteppingGranularity", - "description": "Optional granularity to step. If no granularity is specified, a granularity of 'statement' is assumed." + "description": "Stepping granularity. If no granularity is specified, a granularity of `statement` is assumed." } }, "required": [ "threadId" ] @@ -1614,14 +1746,14 @@ "StepInResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'stepIn' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `stepIn` request. This is just an acknowledgement, so no body field is required." }] }, "StepOutRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request starts the debuggee to run again for one step.\nThe debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.", + "description": "The request resumes the given thread to step out (return) from a function/method and allows all other threads to run freely by resuming them.\nIf the debug adapter supports single thread execution (see capability `supportsSingleThreadExecutionRequests`), setting the `singleThread` argument to true prevents other suspended threads from resuming.\nThe debug adapter first sends the response and then a `stopped` event (with reason `step`) after the step has completed.", "properties": { "command": { "type": "string", @@ -1636,15 +1768,19 @@ }, "StepOutArguments": { "type": "object", - "description": "Arguments for 'stepOut' request.", + "description": "Arguments for `stepOut` request.", "properties": { "threadId": { "type": "integer", - "description": "Execute 'stepOut' for this thread." + "description": "Specifies the thread for which to resume execution for one step-out (of the given granularity)." + }, + "singleThread": { + "type": "boolean", + "description": "If this flag is true, all other suspended threads are not resumed." }, "granularity": { "$ref": "#/definitions/SteppingGranularity", - "description": "Optional granularity to step. If no granularity is specified, a granularity of 'statement' is assumed." + "description": "Stepping granularity. If no granularity is specified, a granularity of `statement` is assumed." } }, "required": [ "threadId" ] @@ -1652,14 +1788,14 @@ "StepOutResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'stepOut' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `stepOut` request. This is just an acknowledgement, so no body field is required." }] }, "StepBackRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request starts the debuggee to run one step backwards.\nThe debug adapter first sends the response and then a 'stopped' event (with reason 'step') after the step has completed.\nClients should only call this request if the capability 'supportsStepBack' is true.", + "description": "The request executes one backward step (in the given granularity) for the specified thread and allows all other threads to run backward freely by resuming them.\nIf the debug adapter supports single thread execution (see capability `supportsSingleThreadExecutionRequests`), setting the `singleThread` argument to true prevents other suspended threads from resuming.\nThe debug adapter first sends the response and then a `stopped` event (with reason `step`) after the step has completed.\nClients should only call this request if the corresponding capability `supportsStepBack` is true.", "properties": { "command": { "type": "string", @@ -1674,15 +1810,19 @@ }, "StepBackArguments": { "type": "object", - "description": "Arguments for 'stepBack' request.", + "description": "Arguments for `stepBack` request.", "properties": { "threadId": { "type": "integer", - "description": "Execute 'stepBack' for this thread." + "description": "Specifies the thread for which to resume execution for one step backwards (of the given granularity)." + }, + "singleThread": { + "type": "boolean", + "description": "If this flag is true, all other suspended threads are not resumed." }, "granularity": { "$ref": "#/definitions/SteppingGranularity", - "description": "Optional granularity to step. If no granularity is specified, a granularity of 'statement' is assumed." + "description": "Stepping granularity to step. If no granularity is specified, a granularity of `statement` is assumed." } }, "required": [ "threadId" ] @@ -1690,14 +1830,14 @@ "StepBackResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'stepBack' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `stepBack` request. This is just an acknowledgement, so no body field is required." }] }, "ReverseContinueRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request starts the debuggee to run backward.\nClients should only call this request if the capability 'supportsStepBack' is true.", + "description": "The request resumes backward execution of all threads. If the debug adapter supports single thread execution (see capability `supportsSingleThreadExecutionRequests`), setting the `singleThread` argument to true resumes only the specified thread. If not all threads were resumed, the `allThreadsContinued` attribute of the response should be set to false.\nClients should only call this request if the corresponding capability `supportsStepBack` is true.", "properties": { "command": { "type": "string", @@ -1712,26 +1852,31 @@ }, "ReverseContinueArguments": { "type": "object", - "description": "Arguments for 'reverseContinue' request.", + "description": "Arguments for `reverseContinue` request.", "properties": { "threadId": { "type": "integer", - "description": "Execute 'reverseContinue' for this thread." + "description": "Specifies the active thread. If the debug adapter supports single thread execution (see `supportsSingleThreadExecutionRequests`) and the `singleThread` argument is true, only the thread with this ID is resumed." + }, + "singleThread": { + "type": "boolean", + "description": "If this flag is true, backward execution is resumed only for the thread with given `threadId`." } + }, "required": [ "threadId" ] }, "ReverseContinueResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'reverseContinue' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `reverseContinue` request. This is just an acknowledgement, so no body field is required." }] }, "RestartFrameRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request restarts execution of the specified stackframe.\nThe debug adapter first sends the response and then a 'stopped' event (with reason 'restart') after the restart has completed.\nClients should only call this request if the capability 'supportsRestartFrame' is true.", + "description": "The request restarts execution of the specified stack frame.\nThe debug adapter first sends the response and then a `stopped` event (with reason `restart`) after the restart has completed.\nClients should only call this request if the corresponding capability `supportsRestartFrame` is true.", "properties": { "command": { "type": "string", @@ -1746,11 +1891,11 @@ }, "RestartFrameArguments": { "type": "object", - "description": "Arguments for 'restartFrame' request.", + "description": "Arguments for `restartFrame` request.", "properties": { "frameId": { "type": "integer", - "description": "Restart this stackframe." + "description": "Restart the stack frame identified by `frameId`. The `frameId` must have been obtained in the current suspended state. See 'Lifetime of Object References' in the Overview section for details." } }, "required": [ "frameId" ] @@ -1758,14 +1903,14 @@ "RestartFrameResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'restartFrame' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `restartFrame` request. This is just an acknowledgement, so no body field is required." }] }, "GotoRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request sets the location where the debuggee will continue to run.\nThis makes it possible to skip the execution of code or to executed code again.\nThe code between the current location and the goto target is not executed but skipped.\nThe debug adapter first sends the response and then a 'stopped' event with reason 'goto'.\nClients should only call this request if the capability 'supportsGotoTargetsRequest' is true (because only then goto targets exist that can be passed as arguments).", + "description": "The request sets the location where the debuggee will continue to run.\nThis makes it possible to skip the execution of code or to execute code again.\nThe code between the current location and the goto target is not executed but skipped.\nThe debug adapter first sends the response and then a `stopped` event with reason `goto`.\nClients should only call this request if the corresponding capability `supportsGotoTargetsRequest` is true (because only then goto targets exist that can be passed as arguments).", "properties": { "command": { "type": "string", @@ -1780,7 +1925,7 @@ }, "GotoArguments": { "type": "object", - "description": "Arguments for 'goto' request.", + "description": "Arguments for `goto` request.", "properties": { "threadId": { "type": "integer", @@ -1796,14 +1941,14 @@ "GotoResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'goto' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `goto` request. This is just an acknowledgement, so no body field is required." }] }, "PauseRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request suspends the debuggee.\nThe debug adapter first sends the response and then a 'stopped' event (with reason 'pause') after the thread has been paused successfully.", + "description": "The request suspends the debuggee.\nThe debug adapter first sends the response and then a `stopped` event (with reason `pause`) after the thread has been paused successfully.", "properties": { "command": { "type": "string", @@ -1818,7 +1963,7 @@ }, "PauseArguments": { "type": "object", - "description": "Arguments for 'pause' request.", + "description": "Arguments for `pause` request.", "properties": { "threadId": { "type": "integer", @@ -1830,14 +1975,14 @@ "PauseResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'pause' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `pause` request. This is just an acknowledgement, so no body field is required." }] }, "StackTraceRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request returns a stacktrace from the current execution state of a given thread.\nA client can request all stack frames by omitting the startFrame and levels arguments. For performance conscious clients and if the debug adapter's 'supportsDelayedStackTraceLoading' capability is true, stack frames can be retrieved in a piecemeal way with the startFrame and levels arguments. The response of the stackTrace request may contain a totalFrames property that hints at the total number of frames in the stack. If a client needs this total number upfront, it can issue a request for a single (first) frame and depending on the value of totalFrames decide how to proceed. In any case a client should be prepared to receive less frames than requested, which is an indication that the end of the stack has been reached.", + "description": "The request returns a stacktrace from the current execution state of a given thread.\nA client can request all stack frames by omitting the startFrame and levels arguments. For performance-conscious clients and if the corresponding capability `supportsDelayedStackTraceLoading` is true, stack frames can be retrieved in a piecemeal way with the `startFrame` and `levels` arguments. The response of the `stackTrace` request may contain a `totalFrames` property that hints at the total number of frames in the stack. If a client needs this total number upfront, it can issue a request for a single (first) frame and depending on the value of `totalFrames` decide how to proceed. In any case a client should be prepared to receive fewer frames than requested, which is an indication that the end of the stack has been reached.", "properties": { "command": { "type": "string", @@ -1852,7 +1997,7 @@ }, "StackTraceArguments": { "type": "object", - "description": "Arguments for 'stackTrace' request.", + "description": "Arguments for `stackTrace` request.", "properties": { "threadId": { "type": "integer", @@ -1868,7 +2013,7 @@ }, "format": { "$ref": "#/definitions/StackFrameFormat", - "description": "Specifies details on how to format the stack frames.\nThe attribute is only honored by a debug adapter if the capability 'supportsValueFormattingOptions' is true." + "description": "Specifies details on how to format the stack frames.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsValueFormattingOptions` is true." } }, "required": [ "threadId" ] @@ -1876,7 +2021,7 @@ "StackTraceResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'stackTrace' request.", + "description": "Response to `stackTrace` request.", "properties": { "body": { "type": "object", @@ -1886,11 +2031,11 @@ "items": { "$ref": "#/definitions/StackFrame" }, - "description": "The frames of the stackframe. If the array has length zero, there are no stackframes available.\nThis means that there is no location information available." + "description": "The frames of the stack frame. If the array has length zero, there are no stack frames available.\nThis means that there is no location information available." }, "totalFrames": { "type": "integer", - "description": "The total number of frames available in the stack. If omitted or if totalFrames is larger than the available frames, a client is expected to request frames until a request returns less frames than requested (which indicates the end of the stack). Returning monotonically increasing totalFrames values for subsequent requests can be used to enforce paging in the client." + "description": "The total number of frames available in the stack. If omitted or if `totalFrames` is larger than the available frames, a client is expected to request frames until a request returns less frames than requested (which indicates the end of the stack). Returning monotonically increasing `totalFrames` values for subsequent requests can be used to enforce paging in the client." } }, "required": [ "stackFrames" ] @@ -1903,7 +2048,7 @@ "ScopesRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request returns the variable scopes for a given stackframe ID.", + "description": "The request returns the variable scopes for a given stack frame ID.", "properties": { "command": { "type": "string", @@ -1918,11 +2063,11 @@ }, "ScopesArguments": { "type": "object", - "description": "Arguments for 'scopes' request.", + "description": "Arguments for `scopes` request.", "properties": { "frameId": { "type": "integer", - "description": "Retrieve the scopes for this stackframe." + "description": "Retrieve the scopes for the stack frame identified by `frameId`. The `frameId` must have been obtained in the current suspended state. See 'Lifetime of Object References' in the Overview section for details." } }, "required": [ "frameId" ] @@ -1930,7 +2075,7 @@ "ScopesResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'scopes' request.", + "description": "Response to `scopes` request.", "properties": { "body": { "type": "object", @@ -1940,7 +2085,7 @@ "items": { "$ref": "#/definitions/Scope" }, - "description": "The scopes of the stackframe. If the array has length zero, there are no scopes available." + "description": "The scopes of the stack frame. If the array has length zero, there are no scopes available." } }, "required": [ "scopes" ] @@ -1953,7 +2098,7 @@ "VariablesRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Retrieves all child variables for the given variable reference.\nAn optional filter can be used to limit the fetched children to either named or indexed children.", + "description": "Retrieves all child variables for the given variable reference.\nA filter can be used to limit the fetched children to either named or indexed children.", "properties": { "command": { "type": "string", @@ -1968,28 +2113,28 @@ }, "VariablesArguments": { "type": "object", - "description": "Arguments for 'variables' request.", + "description": "Arguments for `variables` request.", "properties": { "variablesReference": { "type": "integer", - "description": "The Variable reference." + "description": "The variable for which to retrieve its children. The `variablesReference` must have been obtained in the current suspended state. See 'Lifetime of Object References' in the Overview section for details." }, "filter": { "type": "string", "enum": [ "indexed", "named" ], - "description": "Optional filter to limit the child variables to either named or indexed. If omitted, both types are fetched." + "description": "Filter to limit the child variables to either named or indexed. If omitted, both types are fetched." }, "start": { "type": "integer", - "description": "The index of the first variable to return; if omitted children start at 0." + "description": "The index of the first variable to return; if omitted children start at 0.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsVariablePaging` is true." }, "count": { "type": "integer", - "description": "The number of variables to return. If count is missing or 0, all variables are returned." + "description": "The number of variables to return. If count is missing or 0, all variables are returned.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsVariablePaging` is true." }, "format": { "$ref": "#/definitions/ValueFormat", - "description": "Specifies details on how to format the Variable values.\nThe attribute is only honored by a debug adapter if the capability 'supportsValueFormattingOptions' is true." + "description": "Specifies details on how to format the Variable values.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsValueFormattingOptions` is true." } }, "required": [ "variablesReference" ] @@ -1997,7 +2142,7 @@ "VariablesResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'variables' request.", + "description": "Response to `variables` request.", "properties": { "body": { "type": "object", @@ -2020,7 +2165,7 @@ "SetVariableRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "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.", + "description": "Set the variable with the given name in the variable container to a new value. Clients should only call this request if the corresponding capability `supportsSetVariable` is true.\nIf a debug adapter implements both `setVariable` and `setExpression`, a client will only use `setExpression` if the variable has an `evaluateName` property.", "properties": { "command": { "type": "string", @@ -2035,11 +2180,11 @@ }, "SetVariableArguments": { "type": "object", - "description": "Arguments for 'setVariable' request.", + "description": "Arguments for `setVariable` request.", "properties": { "variablesReference": { "type": "integer", - "description": "The reference of the variable container." + "description": "The reference of the variable container. The `variablesReference` must have been obtained in the current suspended state. See 'Lifetime of Object References' in the Overview section for details." }, "name": { "type": "string", @@ -2059,7 +2204,7 @@ "SetVariableResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'setVariable' request.", + "description": "Response to `setVariable` request.", "properties": { "body": { "type": "object", @@ -2074,15 +2219,15 @@ }, "variablesReference": { "type": "integer", - "description": "If variablesReference is > 0, the new value is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "If `variablesReference` is > 0, the new value is structured and its children can be retrieved by passing `variablesReference` to the `variables` request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details." }, "namedVariables": { "type": "integer", - "description": "The number of named child variables.\nThe client can use this optional information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "The number of named child variables.\nThe client can use this information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." }, "indexedVariables": { "type": "integer", - "description": "The number of indexed child variables.\nThe client can use this optional information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "The number of indexed child variables.\nThe client can use this information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." } }, "required": [ "value" ] @@ -2110,15 +2255,15 @@ }, "SourceArguments": { "type": "object", - "description": "Arguments for 'source' request.", + "description": "Arguments for `source` request.", "properties": { "source": { "$ref": "#/definitions/Source", - "description": "Specifies the source content to load. Either source.path or source.sourceReference must be specified." + "description": "Specifies the source content to load. Either `source.path` or `source.sourceReference` must be specified." }, "sourceReference": { "type": "integer", - "description": "The reference to the source. This is the same as source.sourceReference.\nThis is provided for backward compatibility since old backends do not understand the 'source' attribute." + "description": "The reference to the source. This is the same as `source.sourceReference`.\nThis is provided for backward compatibility since old clients do not understand the `source` attribute." } }, "required": [ "sourceReference" ] @@ -2126,7 +2271,7 @@ "SourceResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'source' request.", + "description": "Response to `source` request.", "properties": { "body": { "type": "object", @@ -2137,7 +2282,7 @@ }, "mimeType": { "type": "string", - "description": "Optional content type (mime type) of the source." + "description": "Content type (MIME type) of the source." } }, "required": [ "content" ] @@ -2163,7 +2308,7 @@ "ThreadsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'threads' request.", + "description": "Response to `threads` request.", "properties": { "body": { "type": "object", @@ -2186,7 +2331,7 @@ "TerminateThreadsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "The request terminates the threads with the given ids.\nClients should only call this request if the capability 'supportsTerminateThreadsRequest' is true.", + "description": "The request terminates the threads with the given ids.\nClients should only call this request if the corresponding capability `supportsTerminateThreadsRequest` is true.", "properties": { "command": { "type": "string", @@ -2201,7 +2346,7 @@ }, "TerminateThreadsArguments": { "type": "object", - "description": "Arguments for 'terminateThreads' request.", + "description": "Arguments for `terminateThreads` request.", "properties": { "threadIds": { "type": "array", @@ -2215,14 +2360,14 @@ "TerminateThreadsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'terminateThreads' request. This is just an acknowledgement, so no body field is required." + "description": "Response to `terminateThreads` request. This is just an acknowledgement, no body field is required." }] }, "ModulesRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "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.\nClients should only call this request if the capability 'supportsModulesRequest' is true.", + "description": "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.\nClients should only call this request if the corresponding capability `supportsModulesRequest` is true.", "properties": { "command": { "type": "string", @@ -2237,7 +2382,7 @@ }, "ModulesArguments": { "type": "object", - "description": "Arguments for 'modules' request.", + "description": "Arguments for `modules` request.", "properties": { "startModule": { "type": "integer", @@ -2245,14 +2390,14 @@ }, "moduleCount": { "type": "integer", - "description": "The number of modules to return. If moduleCount is not specified or 0, all modules are returned." + "description": "The number of modules to return. If `moduleCount` is not specified or 0, all modules are returned." } } }, "ModulesResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'modules' request.", + "description": "Response to `modules` request.", "properties": { "body": { "type": "object", @@ -2279,7 +2424,7 @@ "LoadedSourcesRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Retrieves the set of all sources currently loaded by the debugged process.\nClients should only call this request if the capability 'supportsLoadedSourcesRequest' is true.", + "description": "Retrieves the set of all sources currently loaded by the debugged process.\nClients should only call this request if the corresponding capability `supportsLoadedSourcesRequest` is true.", "properties": { "command": { "type": "string", @@ -2294,12 +2439,12 @@ }, "LoadedSourcesArguments": { "type": "object", - "description": "Arguments for 'loadedSources' request." + "description": "Arguments for `loadedSources` request." }, "LoadedSourcesResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'loadedSources' request.", + "description": "Response to `loadedSources` request.", "properties": { "body": { "type": "object", @@ -2322,7 +2467,7 @@ "EvaluateRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Evaluates the given expression in the context of the top most stack frame.\nThe expression has access to any variables and arguments that are in scope.", + "description": "Evaluates the given expression in the context of the topmost stack frame.\nThe expression has access to any variables and arguments that are in scope.", "properties": { "command": { "type": "string", @@ -2337,7 +2482,7 @@ }, "EvaluateArguments": { "type": "object", - "description": "Arguments for 'evaluate' request.", + "description": "Arguments for `evaluate` request.", "properties": { "expression": { "type": "string", @@ -2349,18 +2494,19 @@ }, "context": { "type": "string", - "_enum": [ "watch", "repl", "hover", "clipboard" ], + "_enum": [ "watch", "repl", "hover", "clipboard", "variables" ], "enumDescriptions": [ - "evaluate is run in a watch.", - "evaluate is run from REPL console.", - "evaluate is run from a data hover.", - "evaluate is run to generate the value that will be stored in the clipboard.\nThe attribute is only honored by a debug adapter if the capability 'supportsClipboardContext' is true." + "evaluate is called from a watch view context.", + "evaluate is called from a REPL context.", + "evaluate is called to generate the debug hover contents.\nThis value should only be used if the corresponding capability `supportsEvaluateForHovers` is true.", + "evaluate is called to generate clipboard contents.\nThis value should only be used if the corresponding capability `supportsClipboardContext` is true.", + "evaluate is called from a variables view context." ], - "description": "The context in which the evaluate request is run." + "description": "The context in which the evaluate request is used." }, "format": { "$ref": "#/definitions/ValueFormat", - "description": "Specifies details on how to format the Evaluate result.\nThe attribute is only honored by a debug adapter if the capability 'supportsValueFormattingOptions' is true." + "description": "Specifies details on how to format the result.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsValueFormattingOptions` is true." } }, "required": [ "expression" ] @@ -2368,7 +2514,7 @@ "EvaluateResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'evaluate' request.", + "description": "Response to `evaluate` request.", "properties": { "body": { "type": "object", @@ -2379,27 +2525,27 @@ }, "type": { "type": "string", - "description": "The optional type of the evaluate result.\nThis attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request." + "description": "The type of the evaluate result.\nThis attribute should only be returned by a debug adapter if the corresponding capability `supportsVariableType` is true." }, "presentationHint": { "$ref": "#/definitions/VariablePresentationHint", - "description": "Properties of a evaluate result that can be used to determine how to render the result in the UI." + "description": "Properties of an evaluate result that can be used to determine how to render the result in the UI." }, "variablesReference": { "type": "integer", - "description": "If variablesReference is > 0, the evaluate result is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "If `variablesReference` is > 0, the evaluate result is structured and its children can be retrieved by passing `variablesReference` to the `variables` request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details." }, "namedVariables": { "type": "integer", - "description": "The number of named child variables.\nThe client can use this optional information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "The number of named child variables.\nThe client can use this information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." }, "indexedVariables": { "type": "integer", - "description": "The number of indexed child variables.\nThe client can use this optional information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "The number of indexed child variables.\nThe client can use this information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." }, "memoryReference": { "type": "string", - "description": "Optional memory reference to a location appropriate for this result.\nFor pointer type eval results, this is generally a reference to the memory address contained in the pointer.\nThis attribute should be returned by a debug adapter if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request." + "description": "A memory reference to a location appropriate for this result.\nFor pointer type eval results, this is generally a reference to the memory address contained in the pointer.\nThis attribute should be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true." } }, "required": [ "result", "variablesReference" ] @@ -2412,7 +2558,7 @@ "SetExpressionRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Evaluates the given 'value' expression and assigns it to the 'expression' which must be a modifiable l-value.\nThe expressions have access to any variables and arguments that are in scope of the specified frame.\nClients should only call this request if the capability 'supportsSetExpression' is true.", + "description": "Evaluates the given `value` expression and assigns it to the `expression` which must be a modifiable l-value.\nThe expressions have access to any variables and arguments that are in scope of the specified frame.\nClients should only call this request if the corresponding capability `supportsSetExpression` is true.\nIf a debug adapter implements both `setExpression` and `setVariable`, a client uses `setExpression` if the variable has an `evaluateName` property.", "properties": { "command": { "type": "string", @@ -2427,7 +2573,7 @@ }, "SetExpressionArguments": { "type": "object", - "description": "Arguments for 'setExpression' request.", + "description": "Arguments for `setExpression` request.", "properties": { "expression": { "type": "string", @@ -2451,7 +2597,7 @@ "SetExpressionResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'setExpression' request.", + "description": "Response to `setExpression` request.", "properties": { "body": { "type": "object", @@ -2462,7 +2608,7 @@ }, "type": { "type": "string", - "description": "The optional type of the value.\nThis attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request." + "description": "The type of the value.\nThis attribute should only be returned by a debug adapter if the corresponding capability `supportsVariableType` is true." }, "presentationHint": { "$ref": "#/definitions/VariablePresentationHint", @@ -2470,15 +2616,15 @@ }, "variablesReference": { "type": "integer", - "description": "If variablesReference is > 0, the value is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "If `variablesReference` is > 0, the evaluate result is structured and its children can be retrieved by passing `variablesReference` to the `variables` request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details." }, "namedVariables": { "type": "integer", - "description": "The number of named child variables.\nThe client can use this optional information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "The number of named child variables.\nThe client can use this information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." }, "indexedVariables": { "type": "integer", - "description": "The number of indexed child variables.\nThe client can use this optional information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "The number of indexed child variables.\nThe client can use this information to present the variables in a paged UI and fetch them in chunks.\nThe value should be less than or equal to 2147483647 (2^31-1)." } }, "required": [ "value" ] @@ -2491,7 +2637,7 @@ "StepInTargetsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "This request retrieves the possible stepIn targets for the specified stack frame.\nThese targets can be used in the 'stepIn' request.\nThe StepInTargets may only be called if the 'supportsStepInTargetsRequest' capability exists and is true.\nClients should only call this request if the capability 'supportsStepInTargetsRequest' is true.", + "description": "This request retrieves the possible step-in targets for the specified stack frame.\nThese targets can be used in the `stepIn` request.\nClients should only call this request if the corresponding capability `supportsStepInTargetsRequest` is true.", "properties": { "command": { "type": "string", @@ -2506,11 +2652,11 @@ }, "StepInTargetsArguments": { "type": "object", - "description": "Arguments for 'stepInTargets' request.", + "description": "Arguments for `stepInTargets` request.", "properties": { "frameId": { "type": "integer", - "description": "The stack frame for which to retrieve the possible stepIn targets." + "description": "The stack frame for which to retrieve the possible step-in targets." } }, "required": [ "frameId" ] @@ -2518,7 +2664,7 @@ "StepInTargetsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'stepInTargets' request.", + "description": "Response to `stepInTargets` request.", "properties": { "body": { "type": "object", @@ -2528,7 +2674,7 @@ "items": { "$ref": "#/definitions/StepInTarget" }, - "description": "The possible stepIn targets of the specified source location." + "description": "The possible step-in targets of the specified source location." } }, "required": [ "targets" ] @@ -2541,7 +2687,7 @@ "GotoTargetsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "This request retrieves the possible goto targets for the specified source location.\nThese targets can be used in the 'goto' request.\nClients should only call this request if the capability 'supportsGotoTargetsRequest' is true.", + "description": "This request retrieves the possible goto targets for the specified source location.\nThese targets can be used in the `goto` request.\nClients should only call this request if the corresponding capability `supportsGotoTargetsRequest` is true.", "properties": { "command": { "type": "string", @@ -2556,7 +2702,7 @@ }, "GotoTargetsArguments": { "type": "object", - "description": "Arguments for 'gotoTargets' request.", + "description": "Arguments for `gotoTargets` request.", "properties": { "source": { "$ref": "#/definitions/Source", @@ -2568,7 +2714,7 @@ }, "column": { "type": "integer", - "description": "An optional column location for which the goto targets are determined." + "description": "The position within `line` for which the goto targets are determined. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." } }, "required": [ "source", "line" ] @@ -2576,7 +2722,7 @@ "GotoTargetsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'gotoTargets' request.", + "description": "Response to `gotoTargets` request.", "properties": { "body": { "type": "object", @@ -2599,7 +2745,7 @@ "CompletionsRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Returns a list of possible completions for a given caret position and text.\nClients should only call this request if the capability 'supportsCompletionsRequest' is true.", + "description": "Returns a list of possible completions for a given caret position and text.\nClients should only call this request if the corresponding capability `supportsCompletionsRequest` is true.", "properties": { "command": { "type": "string", @@ -2614,7 +2760,7 @@ }, "CompletionsArguments": { "type": "object", - "description": "Arguments for 'completions' request.", + "description": "Arguments for `completions` request.", "properties": { "frameId": { "type": "integer", @@ -2622,15 +2768,15 @@ }, "text": { "type": "string", - "description": "One or more source lines. Typically this is the text a user has typed into the debug console before he asked for completion." + "description": "One or more source lines. Typically this is the text users have typed into the debug console before they asked for completion." }, "column": { "type": "integer", - "description": "The character position for which to determine the completion proposals." + "description": "The position within `text` for which to determine the completion proposals. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." }, "line": { "type": "integer", - "description": "An optional line for which to determine the completion proposals. If missing the first line of the text is assumed." + "description": "A line for which to determine the completion proposals. If missing the first line of the text is assumed." } }, "required": [ "text", "column" ] @@ -2638,7 +2784,7 @@ "CompletionsResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'completions' request.", + "description": "Response to `completions` request.", "properties": { "body": { "type": "object", @@ -2661,7 +2807,7 @@ "ExceptionInfoRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Retrieves the details of the exception that caused this event to be raised.\nClients should only call this request if the capability 'supportsExceptionInfoRequest' is true.", + "description": "Retrieves the details of the exception that caused this event to be raised.\nClients should only call this request if the corresponding capability `supportsExceptionInfoRequest` is true.", "properties": { "command": { "type": "string", @@ -2676,7 +2822,7 @@ }, "ExceptionInfoArguments": { "type": "object", - "description": "Arguments for 'exceptionInfo' request.", + "description": "Arguments for `exceptionInfo` request.", "properties": { "threadId": { "type": "integer", @@ -2688,7 +2834,7 @@ "ExceptionInfoResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'exceptionInfo' request.", + "description": "Response to `exceptionInfo` request.", "properties": { "body": { "type": "object", @@ -2699,7 +2845,7 @@ }, "description": { "type": "string", - "description": "Descriptive text for the exception provided by the debug adapter." + "description": "Descriptive text for the exception." }, "breakMode": { "$ref": "#/definitions/ExceptionBreakMode", @@ -2720,7 +2866,7 @@ "ReadMemoryRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Reads bytes from memory at the provided location.\nClients should only call this request if the capability 'supportsReadMemoryRequest' is true.", + "description": "Reads bytes from memory at the provided location.\nClients should only call this request if the corresponding capability `supportsReadMemoryRequest` is true.", "properties": { "command": { "type": "string", @@ -2735,7 +2881,7 @@ }, "ReadMemoryArguments": { "type": "object", - "description": "Arguments for 'readMemory' request.", + "description": "Arguments for `readMemory` request.", "properties": { "memoryReference": { "type": "string", @@ -2743,7 +2889,7 @@ }, "offset": { "type": "integer", - "description": "Optional offset (in bytes) to be applied to the reference location before reading data. Can be negative." + "description": "Offset (in bytes) to be applied to the reference location before reading data. Can be negative." }, "count": { "type": "integer", @@ -2755,22 +2901,22 @@ "ReadMemoryResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'readMemory' request.", + "description": "Response to `readMemory` request.", "properties": { "body": { "type": "object", "properties": { "address": { "type": "string", - "description": "The address of the first byte of data returned.\nTreated as a hex value if prefixed with '0x', or as a decimal value otherwise." + "description": "The address of the first byte of data returned.\nTreated as a hex value if prefixed with `0x`, or as a decimal value otherwise." }, "unreadableBytes": { "type": "integer", - "description": "The number of unreadable bytes encountered after the last successfully read byte.\nThis can be used to determine the number of bytes that must be skipped before a subsequent 'readMemory' request will succeed." + "description": "The number of unreadable bytes encountered after the last successfully read byte.\nThis can be used to determine the number of bytes that should be skipped before a subsequent `readMemory` request succeeds." }, "data": { "type": "string", - "description": "The bytes read from memory, encoded using base64." + "description": "The bytes read from memory, encoded using base64. If the decoded length of `data` is less than the requested `count` in the original `readMemory` request, and `unreadableBytes` is zero or omitted, then the client should assume it's reached the end of readable memory." } }, "required": [ "address" ] @@ -2779,10 +2925,71 @@ }] }, + "WriteMemoryRequest": { + "allOf": [ { "$ref": "#/definitions/Request" }, { + "type": "object", + "description": "Writes bytes to memory at the provided location.\nClients should only call this request if the corresponding capability `supportsWriteMemoryRequest` is true.", + "properties": { + "command": { + "type": "string", + "enum": [ "writeMemory" ] + }, + "arguments": { + "$ref": "#/definitions/WriteMemoryArguments" + } + }, + "required": [ "command", "arguments" ] + }] + }, + "WriteMemoryArguments": { + "type": "object", + "description": "Arguments for `writeMemory` request.", + "properties": { + "memoryReference": { + "type": "string", + "description": "Memory reference to the base location to which data should be written." + }, + "offset": { + "type": "integer", + "description": "Offset (in bytes) to be applied to the reference location before writing data. Can be negative." + }, + "allowPartial": { + "type": "boolean", + "description": "Property to control partial writes. If true, the debug adapter should attempt to write memory even if the entire memory region is not writable. In such a case the debug adapter should stop after hitting the first byte of memory that cannot be written and return the number of bytes written in the response via the `offset` and `bytesWritten` properties.\nIf false or missing, a debug adapter should attempt to verify the region is writable before writing, and fail the response if it is not." + }, + "data": { + "type": "string", + "description": "Bytes to write, encoded using base64." + } + }, + "required": [ "memoryReference", "data" ] + }, + "WriteMemoryResponse": { + "allOf": [ { "$ref": "#/definitions/Response" }, { + "type": "object", + "description": "Response to `writeMemory` request.", + "properties": { + "body": { + "type": "object", + "properties": { + "offset": { + "type": "integer", + "description": "Property that should be returned when `allowPartial` is true to indicate the offset of the first byte of data successfully written. Can be negative." + }, + "bytesWritten": { + "type": "integer", + "description": "Property that should be returned when `allowPartial` is true to indicate the number of bytes starting from address that were successfully written." + } + } + } + } + }] + }, + "DisassembleRequest": { "allOf": [ { "$ref": "#/definitions/Request" }, { "type": "object", - "description": "Disassembles code stored at the provided location.\nClients should only call this request if the capability 'supportsDisassembleRequest' is true.", + "description": "Disassembles code stored at the provided location.\nClients should only call this request if the corresponding capability `supportsDisassembleRequest` is true.", "properties": { "command": { "type": "string", @@ -2797,7 +3004,7 @@ }, "DisassembleArguments": { "type": "object", - "description": "Arguments for 'disassemble' request.", + "description": "Arguments for `disassemble` request.", "properties": { "memoryReference": { "type": "string", @@ -2805,11 +3012,11 @@ }, "offset": { "type": "integer", - "description": "Optional offset (in bytes) to be applied to the reference location before disassembling. Can be negative." + "description": "Offset (in bytes) to be applied to the reference location before disassembling. Can be negative." }, "instructionOffset": { "type": "integer", - "description": "Optional offset (in instructions) to be applied after the byte offset (if any) before disassembling. Can be negative." + "description": "Offset (in instructions) to be applied after the byte offset (if any) before disassembling. Can be negative." }, "instructionCount": { "type": "integer", @@ -2825,7 +3032,7 @@ "DisassembleResponse": { "allOf": [ { "$ref": "#/definitions/Response" }, { "type": "object", - "description": "Response to 'disassemble' request.", + "description": "Response to `disassemble` request.", "properties": { "body": { "type": "object", @@ -2851,7 +3058,7 @@ "properties": { "supportsConfigurationDoneRequest": { "type": "boolean", - "description": "The debug adapter supports the 'configurationDone' request." + "description": "The debug adapter supports the `configurationDone` request." }, "supportsFunctionBreakpoints": { "type": "boolean", @@ -2867,18 +3074,18 @@ }, "supportsEvaluateForHovers": { "type": "boolean", - "description": "The debug adapter supports a (side effect free) evaluate request for data hovers." + "description": "The debug adapter supports a (side effect free) `evaluate` request for data hovers." }, "exceptionBreakpointFilters": { "type": "array", "items": { "$ref": "#/definitions/ExceptionBreakpointsFilter" }, - "description": "Available exception filter options for the 'setExceptionBreakpoints' request." + "description": "Available exception filter options for the `setExceptionBreakpoints` request." }, "supportsStepBack": { "type": "boolean", - "description": "The debug adapter supports stepping back via the 'stepBack' and 'reverseContinue' requests." + "description": "The debug adapter supports stepping back via the `stepBack` and `reverseContinue` requests." }, "supportsSetVariable": { "type": "boolean", @@ -2890,26 +3097,26 @@ }, "supportsGotoTargetsRequest": { "type": "boolean", - "description": "The debug adapter supports the 'gotoTargets' request." + "description": "The debug adapter supports the `gotoTargets` request." }, "supportsStepInTargetsRequest": { "type": "boolean", - "description": "The debug adapter supports the 'stepInTargets' request." + "description": "The debug adapter supports the `stepInTargets` request." }, "supportsCompletionsRequest": { "type": "boolean", - "description": "The debug adapter supports the 'completions' request." + "description": "The debug adapter supports the `completions` request." }, "completionTriggerCharacters": { "type": "array", "items": { "type": "string" }, - "description": "The set of characters that should trigger completion in a REPL. If not specified, the UI should assume the '.' character." + "description": "The set of characters that should trigger completion in a REPL. If not specified, the UI should assume the `.` character." }, "supportsModulesRequest": { "type": "boolean", - "description": "The debug adapter supports the 'modules' request." + "description": "The debug adapter supports the `modules` request." }, "additionalModuleColumns": { "type": "array", @@ -2927,51 +3134,51 @@ }, "supportsRestartRequest": { "type": "boolean", - "description": "The debug adapter supports the 'restart' request. In this case a client should not implement 'restart' by terminating and relaunching the adapter but by calling the RestartRequest." + "description": "The debug adapter supports the `restart` request. In this case a client should not implement `restart` by terminating and relaunching the adapter but by calling the `restart` request." }, "supportsExceptionOptions": { "type": "boolean", - "description": "The debug adapter supports 'exceptionOptions' on the setExceptionBreakpoints request." + "description": "The debug adapter supports `exceptionOptions` on the `setExceptionBreakpoints` request." }, "supportsValueFormattingOptions": { "type": "boolean", - "description": "The debug adapter supports a 'format' attribute on the stackTraceRequest, variablesRequest, and evaluateRequest." + "description": "The debug adapter supports a `format` attribute on the `stackTrace`, `variables`, and `evaluate` requests." }, "supportsExceptionInfoRequest": { "type": "boolean", - "description": "The debug adapter supports the 'exceptionInfo' request." + "description": "The debug adapter supports the `exceptionInfo` request." }, "supportTerminateDebuggee": { "type": "boolean", - "description": "The debug adapter supports the 'terminateDebuggee' attribute on the 'disconnect' request." + "description": "The debug adapter supports the `terminateDebuggee` attribute on the `disconnect` request." }, "supportSuspendDebuggee": { "type": "boolean", - "description": "The debug adapter supports the 'suspendDebuggee' attribute on the 'disconnect' request." + "description": "The debug adapter supports the `suspendDebuggee` attribute on the `disconnect` request." }, "supportsDelayedStackTraceLoading": { "type": "boolean", - "description": "The debug adapter supports the delayed loading of parts of the stack, which requires that both the 'startFrame' and 'levels' arguments and an optional 'totalFrames' result of the 'StackTrace' request are supported." + "description": "The debug adapter supports the delayed loading of parts of the stack, which requires that both the `startFrame` and `levels` arguments and the `totalFrames` result of the `stackTrace` request are supported." }, "supportsLoadedSourcesRequest": { "type": "boolean", - "description": "The debug adapter supports the 'loadedSources' request." + "description": "The debug adapter supports the `loadedSources` request." }, "supportsLogPoints": { "type": "boolean", - "description": "The debug adapter supports logpoints by interpreting the 'logMessage' attribute of the SourceBreakpoint." + "description": "The debug adapter supports log points by interpreting the `logMessage` attribute of the `SourceBreakpoint`." }, "supportsTerminateThreadsRequest": { "type": "boolean", - "description": "The debug adapter supports the 'terminateThreads' request." + "description": "The debug adapter supports the `terminateThreads` request." }, "supportsSetExpression": { "type": "boolean", - "description": "The debug adapter supports the 'setExpression' request." + "description": "The debug adapter supports the `setExpression` request." }, "supportsTerminateRequest": { "type": "boolean", - "description": "The debug adapter supports the 'terminate' request." + "description": "The debug adapter supports the `terminate` request." }, "supportsDataBreakpoints": { "type": "boolean", @@ -2979,27 +3186,31 @@ }, "supportsReadMemoryRequest": { "type": "boolean", - "description": "The debug adapter supports the 'readMemory' request." + "description": "The debug adapter supports the `readMemory` request." + }, + "supportsWriteMemoryRequest": { + "type": "boolean", + "description": "The debug adapter supports the `writeMemory` request." }, "supportsDisassembleRequest": { "type": "boolean", - "description": "The debug adapter supports the 'disassemble' request." + "description": "The debug adapter supports the `disassemble` request." }, "supportsCancelRequest": { "type": "boolean", - "description": "The debug adapter supports the 'cancel' request." + "description": "The debug adapter supports the `cancel` request." }, "supportsBreakpointLocationsRequest": { "type": "boolean", - "description": "The debug adapter supports the 'breakpointLocations' request." + "description": "The debug adapter supports the `breakpointLocations` request." }, "supportsClipboardContext": { "type": "boolean", - "description": "The debug adapter supports the 'clipboard' context value in the 'evaluate' request." + "description": "The debug adapter supports the `clipboard` context value in the `evaluate` request." }, "supportsSteppingGranularity": { "type": "boolean", - "description": "The debug adapter supports stepping granularities (argument 'granularity') for the stepping requests." + "description": "The debug adapter supports stepping granularities (argument `granularity`) for the stepping requests." }, "supportsInstructionBreakpoints": { "type": "boolean", @@ -3007,30 +3218,34 @@ }, "supportsExceptionFilterOptions": { "type": "boolean", - "description": "The debug adapter supports 'filterOptions' as an argument on the 'setExceptionBreakpoints' request." + "description": "The debug adapter supports `filterOptions` as an argument on the `setExceptionBreakpoints` request." + }, + "supportsSingleThreadExecutionRequests": { + "type": "boolean", + "description": "The debug adapter supports the `singleThread` property on the execution requests (`continue`, `next`, `stepIn`, `stepOut`, `reverseContinue`, `stepBack`)." } } }, "ExceptionBreakpointsFilter": { "type": "object", - "description": "An ExceptionBreakpointsFilter is shown in the UI as an filter option for configuring how exceptions are dealt with.", + "description": "An `ExceptionBreakpointsFilter` is shown in the UI as an filter option for configuring how exceptions are dealt with.", "properties": { "filter": { "type": "string", - "description": "The internal ID of the filter option. This value is passed to the 'setExceptionBreakpoints' request." + "description": "The internal ID of the filter option. This value is passed to the `setExceptionBreakpoints` request." }, "label": { "type": "string", - "description": "The name of the filter option. This will be shown in the UI." + "description": "The name of the filter option. This is shown in the UI." }, "description": { "type": "string", - "description": "An optional help text providing additional information about the exception filter. This string is typically shown as a hover and must be translated." + "description": "A help text providing additional information about the exception filter. This string is typically shown as a hover and can be translated." }, "default": { "type": "boolean", - "description": "Initial value of the filter option. If not specified a value 'false' is assumed." + "description": "Initial value of the filter option. If not specified a value false is assumed." }, "supportsCondition": { "type": "boolean", @@ -3038,7 +3253,7 @@ }, "conditionDescription": { "type": "string", - "description": "An optional help text providing information about the condition. This string is shown as the placeholder text for a text box and must be translated." + "description": "A help text providing information about the condition. This string is shown as the placeholder text for a text box and can be translated." } }, "required": [ "filter", "label" ] @@ -3050,18 +3265,18 @@ "properties": { "id": { "type": "integer", - "description": "Unique identifier for the message." + "description": "Unique (within a debug adapter implementation) identifier for the message. The purpose of these error IDs is to help extension authors that have the requirement that every user visible error message needs a corresponding error number, so that users or customer support can find information about the specific error more easily." }, "format": { "type": "string", - "description": "A format string for the message. Embedded variables have the form '{name}'.\nIf variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes." + "description": "A format string for the message. Embedded variables have the form `{name}`.\nIf variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes." }, "variables": { "type": "object", "description": "An object used as a dictionary for looking up the variables in the format string.", "additionalProperties": { "type": "string", - "description": "Values must be strings." + "description": "All dictionary values must be strings." } }, "sendTelemetry": { @@ -3074,11 +3289,11 @@ }, "url": { "type": "string", - "description": "An optional url where additional information about this message can be found." + "description": "A url where additional information about this message can be found." }, "urlLabel": { "type": "string", - "description": "An optional label that is presented to the user as the UI for opening the url." + "description": "A label that is presented to the user as the UI for opening the url." } }, "required": [ "id", "format" ] @@ -3086,7 +3301,7 @@ "Module": { "type": "object", - "description": "A Module object represents a row in the modules view.\nTwo 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.\nThe name is used to minimally render the module in the UI.\n\nAdditional attributes can be added to the module. They will show up in the module View if they have a corresponding ColumnDescriptor.\n\nTo avoid an unnecessary proliferation of additional attributes with similar semantics but different names\nwe recommend to re-use attributes from the 'recommended' list below first, and only introduce new attributes if nothing appropriate could be found.", + "description": "A Module object represents a row in the modules view.\nThe `id` attribute identifies a module in the modules view and is used in a `module` event for identifying a module for adding, updating or deleting.\nThe `name` attribute is used to minimally render the module in the UI.\n\nAdditional attributes can be added to the module. They show up in the module view if they have a corresponding `ColumnDescriptor`.\n\nTo avoid an unnecessary proliferation of additional attributes with similar semantics but different names, we recommend to re-use attributes from the 'recommended' list below first, and only introduce new attributes if nothing appropriate could be found.", "properties": { "id": { "type": ["integer", "string"], @@ -3098,7 +3313,7 @@ }, "path": { "type": "string", - "description": "optional but recommended attributes.\nalways try to use these first before introducing additional attributes.\n\nLogical full path to the module. The exact definition is implementation defined, but usually this would be a full path to the on-disk file for the module." + "description": "Logical full path to the module. The exact definition is implementation defined, but usually this would be a full path to the on-disk file for the module." }, "isOptimized": { "type": "boolean", @@ -3114,7 +3329,7 @@ }, "symbolStatus": { "type": "string", - "description": "User understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc." + "description": "User-understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc.)" }, "symbolFilePath": { "type": "string", @@ -3122,7 +3337,7 @@ }, "dateTimeStamp": { "type": "string", - "description": "Module created or modified." + "description": "Module created or modified, encoded as a RFC 3339 timestamp." }, "addressRange": { "type": "string", @@ -3134,7 +3349,7 @@ "ColumnDescriptor": { "type": "object", - "description": "A ColumnDescriptor specifies what module attribute to show in a column of the ModulesView, how to format it,\nand what the column's label should be.\nIt is only used if the underlying UI actually supports this level of customization.", + "description": "A `ColumnDescriptor` specifies what module attribute to show in a column of the modules view, how to format it,\nand what the column's label should be.\nIt is only used if the underlying UI actually supports this level of customization.", "properties": { "attributeName": { "type": "string", @@ -3151,7 +3366,7 @@ "type": { "type": "string", "enum": [ "string", "number", "boolean", "unixTimestampUTC" ], - "description": "Datatype of values in this column. Defaults to 'string' if not specified." + "description": "Datatype of values in this column. Defaults to `string` if not specified." }, "width": { "type": "integer", @@ -3161,20 +3376,6 @@ "required": [ "attributeName", "label"] }, - "ModulesViewDescriptor": { - "type": "object", - "description": "The ModulesViewDescriptor is the container for all declarative configuration options of a ModuleView.\nFor now it only specifies the columns to be shown in the modules view.", - "properties": { - "columns": { - "type": "array", - "items": { - "$ref": "#/definitions/ColumnDescriptor" - } - } - }, - "required": [ "columns" ] - }, - "Thread": { "type": "object", "description": "A Thread", @@ -3185,7 +3386,7 @@ }, "name": { "type": "string", - "description": "A name of the thread." + "description": "The name of the thread." } }, "required": [ "id", "name" ] @@ -3193,7 +3394,7 @@ "Source": { "type": "object", - "description": "A Source is a descriptor for source code.\nIt is returned from the debug adapter as part of a StackFrame and it is used by clients when specifying breakpoints.", + "description": "A `Source` is a descriptor for source code.\nIt is returned from the debug adapter as part of a `StackFrame` and it is used by clients when specifying breakpoints.", "properties": { "name": { "type": "string", @@ -3201,31 +3402,31 @@ }, "path": { "type": "string", - "description": "The path of the source to be shown in the UI.\nIt is only used to locate and load the content of the source if no sourceReference is specified (or its value is 0)." + "description": "The path of the source to be shown in the UI.\nIt is only used to locate and load the content of the source if no `sourceReference` is specified (or its value is 0)." }, "sourceReference": { "type": "integer", - "description": "If sourceReference > 0 the contents of the source must be retrieved through the SourceRequest (even if a path is specified).\nA sourceReference is only valid for a session, so it must not be used to persist a source.\nThe value should be less than or equal to 2147483647 (2^31-1)." + "description": "If the value > 0 the contents of the source must be retrieved through the `source` request (even if a path is specified).\nSince a `sourceReference` is only valid for a session, it can not be used to persist a source.\nThe value should be less than or equal to 2147483647 (2^31-1)." }, "presentationHint": { "type": "string", - "description": "An optional hint for how to present the source in the UI.\nA value of 'deemphasize' can be used to indicate that the source is not available or that it is skipped on stepping.", + "description": "A hint for how to present the source in the UI.\nA value of `deemphasize` can be used to indicate that the source is not available or that it is skipped on stepping.", "enum": [ "normal", "emphasize", "deemphasize" ] }, "origin": { "type": "string", - "description": "The (optional) origin of this source: possible values 'internal module', 'inlined content from source map', etc." + "description": "The origin of this source. For example, 'internal module', 'inlined content from source map', etc." }, "sources": { "type": "array", "items": { "$ref": "#/definitions/Source" }, - "description": "An optional list of sources that are related to this source. These may be the source that generated this source." + "description": "A list of sources that are related to this source. These may be the source that generated this source." }, "adapterData": { "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ], - "description": "Optional data that a debug adapter might want to loop through the client.\nThe client should leave the data intact and persist it across sessions. The client should not interpret the data." + "description": "Additional data that a debug adapter might want to loop through the client.\nThe client should leave the data intact and persist it across sessions. The client should not interpret the data." }, "checksums": { "type": "array", @@ -3243,7 +3444,7 @@ "properties": { "id": { "type": "integer", - "description": "An identifier for the stack frame. It must be unique across all threads.\nThis id can be used to retrieve the scopes of the frame with the 'scopesRequest' or to restart the execution of a stackframe." + "description": "An identifier for the stack frame. It must be unique across all threads.\nThis id can be used to retrieve the scopes of the frame with the `scopes` request or to restart the execution of a stack frame." }, "name": { "type": "string", @@ -3251,31 +3452,31 @@ }, "source": { "$ref": "#/definitions/Source", - "description": "The optional source of the frame." + "description": "The source of the frame." }, "line": { "type": "integer", - "description": "The line within the file of the frame. If source is null or doesn't exist, line is 0 and must be ignored." + "description": "The line within the source of the frame. If the source attribute is missing or doesn't exist, `line` is 0 and should be ignored by the client." }, "column": { "type": "integer", - "description": "The column within the line. If source is null or doesn't exist, column is 0 and must be ignored." + "description": "Start position of the range covered by the stack frame. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based. If attribute `source` is missing or doesn't exist, `column` is 0 and should be ignored by the client." }, "endLine": { "type": "integer", - "description": "An optional end line of the range covered by the stack frame." + "description": "The end line of the range covered by the stack frame." }, "endColumn": { "type": "integer", - "description": "An optional end column of the range covered by the stack frame." + "description": "End position of the range covered by the stack frame. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." }, "canRestart": { "type": "boolean", - "description": "Indicates whether this frame can be restarted with the 'restart' request. Clients should only use this if the debug adapter supports the 'restart' request (capability 'supportsRestartRequest' is true)." + "description": "Indicates whether this frame can be restarted with the `restart` request. Clients should only use this if the debug adapter supports the `restart` request and the corresponding capability `supportsRestartRequest` is true. If a debug adapter has this capability, then `canRestart` defaults to `true` if the property is absent." }, "instructionPointerReference": { "type": "string", - "description": "Optional memory reference for the current instruction pointer in this frame." + "description": "A memory reference for the current instruction pointer in this frame." }, "moduleId": { "type": ["integer", "string"], @@ -3284,7 +3485,7 @@ "presentationHint": { "type": "string", "enum": [ "normal", "label", "subtle" ], - "description": "An optional hint for how to present this frame in the UI.\nA value of 'label' can be used to indicate that the frame is an artificial frame that is used as a visual label or separator. A value of 'subtle' can be used to change the appearance of a frame in a 'subtle' way." + "description": "A hint for how to present this frame in the UI.\nA value of `label` can be used to indicate that the frame is an artificial frame that is used as a visual label or separator. A value of `subtle` can be used to change the appearance of a frame in a 'subtle' way." } }, "required": [ "id", "name", "line", "column" ] @@ -3292,7 +3493,7 @@ "Scope": { "type": "object", - "description": "A Scope is a named container for variables. Optionally a scope can map to a source or a range within a source.", + "description": "A `Scope` is a named container for variables. Optionally a scope can map to a source or a range within a source.", "properties": { "name": { "type": "string", @@ -3300,25 +3501,25 @@ }, "presentationHint": { "type": "string", - "description": "An optional hint for how to present this scope in the UI. If this attribute is missing, the scope is shown with a generic UI.", + "description": "A hint for how to present this scope in the UI. If this attribute is missing, the scope is shown with a generic UI.", "_enum": [ "arguments", "locals", "registers" ], "enumDescriptions": [ "Scope contains method arguments.", "Scope contains local variables.", - "Scope contains registers. Only a single 'registers' scope should be returned from a 'scopes' request." + "Scope contains registers. Only a single `registers` scope should be returned from a `scopes` request." ] }, "variablesReference": { "type": "integer", - "description": "The variables of this scope can be retrieved by passing the value of variablesReference to the VariablesRequest." + "description": "The variables of this scope can be retrieved by passing the value of `variablesReference` to the `variables` request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details." }, "namedVariables": { "type": "integer", - "description": "The number of named variables in this scope.\nThe client can use this optional information to present the variables in a paged UI and fetch them in chunks." + "description": "The number of named variables in this scope.\nThe client can use this information to present the variables in a paged UI and fetch them in chunks." }, "indexedVariables": { "type": "integer", - "description": "The number of indexed variables in this scope.\nThe client can use this optional information to present the variables in a paged UI and fetch them in chunks." + "description": "The number of indexed variables in this scope.\nThe client can use this information to present the variables in a paged UI and fetch them in chunks." }, "expensive": { "type": "boolean", @@ -3326,23 +3527,23 @@ }, "source": { "$ref": "#/definitions/Source", - "description": "Optional source for this scope." + "description": "The source for this scope." }, "line": { "type": "integer", - "description": "Optional start line of the range covered by this scope." + "description": "The start line of the range covered by this scope." }, "column": { "type": "integer", - "description": "Optional start column of the range covered by this scope." + "description": "Start position of the range covered by the scope. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." }, "endLine": { "type": "integer", - "description": "Optional end line of the range covered by this scope." + "description": "The end line of the range covered by this scope." }, "endColumn": { "type": "integer", - "description": "Optional end column of the range covered by this scope." + "description": "End position of the range covered by the scope. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." } }, "required": [ "name", "variablesReference", "expensive" ] @@ -3350,7 +3551,7 @@ "Variable": { "type": "object", - "description": "A Variable is a name/value pair.\nOptionally a variable can have a 'type' that is shown if space permits or when hovering over the variable's name.\nAn 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.\nIf the value is structured (has children), a handle is provided to retrieve the children with the VariablesRequest.\nIf the number of named or indexed children is large, the numbers should be returned via the optional 'namedVariables' and 'indexedVariables' attributes.\nThe client can use this optional information to present the children in a paged UI and fetch them in chunks.", + "description": "A Variable is a name/value pair.\nThe `type` attribute is shown if space permits or when hovering over the variable's name.\nThe `kind` attribute 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.\nIf the value is structured (has children), a handle is provided to retrieve the children with the `variables` request.\nIf the number of named or indexed children is large, the numbers should be returned via the `namedVariables` and `indexedVariables` attributes.\nThe client can use this information to present the children in a paged UI and fetch them in chunks.", "properties": { "name": { "type": "string", @@ -3358,11 +3559,11 @@ }, "value": { "type": "string", - "description": "The variable's value. This can be a multi-line text, e.g. for a function the body of a function." + "description": "The variable's value.\nThis can be a multi-line text, e.g. for a function the body of a function.\nFor structured variables (which do not have a simple value), it is recommended to provide a one-line representation of the structured object. This helps to identify the structured object in the collapsed state when its children are not yet visible.\nAn empty string can be used if no value should be shown in the UI." }, "type": { "type": "string", - "description": "The type of the variable's value. Typically shown in the UI when hovering over the value.\nThis attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request." + "description": "The type of the variable's value. Typically shown in the UI when hovering over the value.\nThis attribute should only be returned by a debug adapter if the corresponding capability `supportsVariableType` is true." }, "presentationHint": { "$ref": "#/definitions/VariablePresentationHint", @@ -3370,23 +3571,23 @@ }, "evaluateName": { "type": "string", - "description": "Optional evaluable name of this variable which can be passed to the 'EvaluateRequest' to fetch the variable's value." + "description": "The evaluatable name of this variable which can be passed to the `evaluate` request to fetch the variable's value." }, "variablesReference": { "type": "integer", - "description": "If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the VariablesRequest." + "description": "If `variablesReference` is > 0, the variable is structured and its children can be retrieved by passing `variablesReference` to the `variables` request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details." }, "namedVariables": { "type": "integer", - "description": "The number of named child variables.\nThe client can use this optional information to present the children in a paged UI and fetch them in chunks." + "description": "The number of named child variables.\nThe client can use this information to present the children in a paged UI and fetch them in chunks." }, "indexedVariables": { "type": "integer", - "description": "The number of indexed child variables.\nThe client can use this optional information to present the children in a paged UI and fetch them in chunks." + "description": "The number of indexed child variables.\nThe client can use this information to present the children in a paged UI and fetch them in chunks." }, "memoryReference": { "type": "string", - "description": "Optional memory reference for the variable if the variable represents executable code, such as a function pointer.\nThis attribute is only required if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request." + "description": "The memory reference for the variable if the variable represents executable code, such as a function pointer.\nThis attribute is only required if the corresponding capability `supportsMemoryReferences` is true." } }, "required": [ "name", "value", "variablesReference" ] @@ -3394,7 +3595,7 @@ "VariablePresentationHint": { "type": "object", - "description": "Optional properties of a variable that can be used to determine how to render the variable in the UI.", + "description": "Properties of a variable that can be used to determine how to render the variable in the UI.", "properties": { "kind": { "description": "The kind of variable. Before introducing additional values, try to use the listed values.", @@ -3410,8 +3611,8 @@ "Indicates that the object is an inner class.", "Indicates that the object is an interface.", "Indicates that the object is the most derived class.", - "Indicates that the object is virtual, that means it is a synthetic object introducedby the\nadapter for rendering purposes, e.g. an index range for large arrays.", - "Deprecated: Indicates that a data breakpoint is registered for the object. The 'hasDataBreakpoint' attribute should generally be used instead." + "Indicates that the object is virtual, that means it is a synthetic object introduced by the adapter for rendering purposes, e.g. an index range for large arrays.", + "Deprecated: Indicates that a data breakpoint is registered for the object. The `hasDataBreakpoint` attribute should generally be used instead." ] }, "attributes": { @@ -3436,13 +3637,17 @@ "description": "Visibility of variable. Before introducing additional values, try to use the listed values.", "type": "string", "_enum": [ "public", "private", "protected", "internal", "final" ] + }, + "lazy": { + "description": "If true, clients can present the variable with a UI that supports a specific gesture to trigger its evaluation.\nThis mechanism can be used for properties that require executing code when retrieving their value and where the code execution can be expensive and/or produce side-effects. A typical example are properties based on a getter function.\nPlease note that in addition to the `lazy` flag, the variable's `variablesReference` is expected to refer to a variable that will provide the value through another `variable` request.", + "type": "boolean" } } }, "BreakpointLocation": { "type": "object", - "description": "Properties of a breakpoint location returned from the 'breakpointLocations' request.", + "description": "Properties of a breakpoint location returned from the `breakpointLocations` request.", "properties": { "line": { "type": "integer", @@ -3450,15 +3655,15 @@ }, "column": { "type": "integer", - "description": "Optional start column of breakpoint location." + "description": "The start position of a breakpoint location. Position is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." }, "endLine": { "type": "integer", - "description": "Optional end line of breakpoint location if the location covers a range." + "description": "The end line of breakpoint location if the location covers a range." }, "endColumn": { "type": "integer", - "description": "Optional end column of breakpoint location if the location covers a range." + "description": "The end position of a breakpoint location (if the location covers a range). Position is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." } }, "required": [ "line" ] @@ -3466,7 +3671,7 @@ "SourceBreakpoint": { "type": "object", - "description": "Properties of a breakpoint or logpoint passed to the setBreakpoints request.", + "description": "Properties of a breakpoint or logpoint passed to the `setBreakpoints` request.", "properties": { "line": { "type": "integer", @@ -3474,19 +3679,19 @@ }, "column": { "type": "integer", - "description": "An optional source column of the breakpoint." + "description": "Start position within source line of the breakpoint or logpoint. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." }, "condition": { "type": "string", - "description": "An optional expression for conditional breakpoints.\nIt is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true." + "description": "The expression for conditional breakpoints.\nIt is only honored by a debug adapter if the corresponding capability `supportsConditionalBreakpoints` is true." }, "hitCondition": { "type": "string", - "description": "An optional expression that controls how many hits of the breakpoint are ignored.\nThe backend is expected to interpret the expression as needed.\nThe attribute is only honored by a debug adapter if the capability 'supportsHitConditionalBreakpoints' is true." + "description": "The expression that controls how many hits of the breakpoint are ignored.\nThe debug adapter is expected to interpret the expression as needed.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsHitConditionalBreakpoints` is true.\nIf both this property and `condition` are specified, `hitCondition` should be evaluated only if the `condition` is met, and the debug adapter should stop only if both conditions are met." }, "logMessage": { "type": "string", - "description": "If this attribute exists and is non-empty, the backend must not 'break' (stop)\nbut log the message instead. Expressions within {} are interpolated.\nThe attribute is only honored by a debug adapter if the capability 'supportsLogPoints' is true." + "description": "If this attribute exists and is non-empty, the debug adapter must not 'break' (stop)\nbut log the message instead. Expressions within `{}` are interpolated.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsLogPoints` is true.\nIf either `hitCondition` or `condition` is specified, then the message should only be logged if those conditions are met." } }, "required": [ "line" ] @@ -3494,7 +3699,7 @@ "FunctionBreakpoint": { "type": "object", - "description": "Properties of a breakpoint passed to the setFunctionBreakpoints request.", + "description": "Properties of a breakpoint passed to the `setFunctionBreakpoints` request.", "properties": { "name": { "type": "string", @@ -3502,11 +3707,11 @@ }, "condition": { "type": "string", - "description": "An optional expression for conditional breakpoints.\nIt is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true." + "description": "An expression for conditional breakpoints.\nIt is only honored by a debug adapter if the corresponding capability `supportsConditionalBreakpoints` is true." }, "hitCondition": { "type": "string", - "description": "An optional expression that controls how many hits of the breakpoint are ignored.\nThe backend is expected to interpret the expression as needed.\nThe attribute is only honored by a debug adapter if the capability 'supportsHitConditionalBreakpoints' is true." + "description": "An expression that controls how many hits of the breakpoint are ignored.\nThe debug adapter is expected to interpret the expression as needed.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsHitConditionalBreakpoints` is true." } }, "required": [ "name" ] @@ -3520,11 +3725,11 @@ "DataBreakpoint": { "type": "object", - "description": "Properties of a data breakpoint passed to the setDataBreakpoints request.", + "description": "Properties of a data breakpoint passed to the `setDataBreakpoints` request.", "properties": { "dataId": { "type": "string", - "description": "An id representing the data. This id is returned from the dataBreakpointInfo request." + "description": "An id representing the data. This id is returned from the `dataBreakpointInfo` request." }, "accessType": { "$ref": "#/definitions/DataBreakpointAccessType", @@ -3532,11 +3737,11 @@ }, "condition": { "type": "string", - "description": "An optional expression for conditional breakpoints." + "description": "An expression for conditional breakpoints." }, "hitCondition": { "type": "string", - "description": "An optional expression that controls how many hits of the breakpoint are ignored.\nThe backend is expected to interpret the expression as needed." + "description": "An expression that controls how many hits of the breakpoint are ignored.\nThe debug adapter is expected to interpret the expression as needed." } }, "required": [ "dataId" ] @@ -3544,23 +3749,23 @@ "InstructionBreakpoint": { "type": "object", - "description": "Properties of a breakpoint passed to the setInstructionBreakpoints request", + "description": "Properties of a breakpoint passed to the `setInstructionBreakpoints` request", "properties": { "instructionReference": { "type": "string", - "description": "The instruction reference of the breakpoint.\nThis should be a memory or instruction pointer reference from an EvaluateResponse, Variable, StackFrame, GotoTarget, or Breakpoint." + "description": "The instruction reference of the breakpoint.\nThis should be a memory or instruction pointer reference from an `EvaluateResponse`, `Variable`, `StackFrame`, `GotoTarget`, or `Breakpoint`." }, "offset": { "type": "integer", - "description": "An optional offset from the instruction reference.\nThis can be negative." + "description": "The offset from the instruction reference.\nThis can be negative." }, "condition": { "type": "string", - "description": "An optional expression for conditional breakpoints.\nIt is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true." + "description": "An expression for conditional breakpoints.\nIt is only honored by a debug adapter if the corresponding capability `supportsConditionalBreakpoints` is true." }, "hitCondition": { "type": "string", - "description": "An optional expression that controls how many hits of the breakpoint are ignored.\nThe backend is expected to interpret the expression as needed.\nThe attribute is only honored by a debug adapter if the capability 'supportsHitConditionalBreakpoints' is true." + "description": "An expression that controls how many hits of the breakpoint are ignored.\nThe debug adapter is expected to interpret the expression as needed.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsHitConditionalBreakpoints` is true." } }, "required": [ "instructionReference" ] @@ -3568,19 +3773,19 @@ "Breakpoint": { "type": "object", - "description": "Information about a Breakpoint created in setBreakpoints, setFunctionBreakpoints, setInstructionBreakpoints, or setDataBreakpoints.", + "description": "Information about a breakpoint created in `setBreakpoints`, `setFunctionBreakpoints`, `setInstructionBreakpoints`, or `setDataBreakpoints` requests.", "properties": { "id": { "type": "integer", - "description": "An optional identifier for the breakpoint. It is needed if breakpoint events are used to update or remove breakpoints." + "description": "The identifier for the breakpoint. It is needed if breakpoint events are used to update or remove breakpoints." }, "verified": { "type": "boolean", - "description": "If true breakpoint could be set (but not necessarily at the desired location)." + "description": "If true, the breakpoint could be set (but not necessarily at the desired location)." }, "message": { "type": "string", - "description": "An optional message about the state of the breakpoint.\nThis is shown to the user and can be used to explain why a breakpoint could not be verified." + "description": "A message about the state of the breakpoint.\nThis is shown to the user and can be used to explain why a breakpoint could not be verified." }, "source": { "$ref": "#/definitions/Source", @@ -3592,23 +3797,23 @@ }, "column": { "type": "integer", - "description": "An optional start column of the actual range covered by the breakpoint." + "description": "Start position of the source range covered by the breakpoint. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." }, "endLine": { "type": "integer", - "description": "An optional end line of the actual range covered by the breakpoint." + "description": "The end line of the actual range covered by the breakpoint." }, "endColumn": { "type": "integer", - "description": "An optional end column of the actual range covered by the breakpoint.\nIf no end line is given, then the end column is assumed to be in the start line." + "description": "End position of the source range covered by the breakpoint. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based.\nIf no end line is given, then the end column is assumed to be in the start line." }, "instructionReference": { "type": "string", - "description": "An optional memory reference to where the breakpoint is set." + "description": "A memory reference to where the breakpoint is set." }, "offset": { "type": "integer", - "description": "An optional offset from the instruction reference.\nThis can be negative." + "description": "The offset from the instruction reference.\nThis can be negative." } }, "required": [ "verified" ] @@ -3616,10 +3821,10 @@ "SteppingGranularity": { "type": "string", - "description": "The granularity of one 'step' in the stepping requests 'next', 'stepIn', 'stepOut', and 'stepBack'.", + "description": "The granularity of one 'step' in the stepping requests `next`, `stepIn`, `stepOut`, and `stepBack`.", "enum": [ "statement", "line", "instruction" ], "enumDescriptions": [ - "The step should allow the program to run until the current statement has finished executing.\nThe meaning of a statement is determined by the adapter and it may be considered equivalent to a line.\nFor example 'for(int i = 0; i < 10; i++) could be considered to have 3 statements 'int i = 0', 'i < 10', and 'i++'.", + "The step should allow the program to run until the current statement has finished executing.\nThe meaning of a statement is determined by the adapter and it may be considered equivalent to a line.\nFor example 'for(int i = 0; i < 10; i++)' could be considered to have 3 statements 'int i = 0', 'i < 10', and 'i++'.", "The step should allow the program to run until the current source line has executed.", "The step should allow one instruction to execute (e.g. one x86 instruction)." ] @@ -3627,15 +3832,31 @@ "StepInTarget": { "type": "object", - "description": "A StepInTarget can be used in the 'stepIn' request and determines into which single target the stepIn request should step.", + "description": "A `StepInTarget` can be used in the `stepIn` request and determines into which single target the `stepIn` request should step.", "properties": { "id": { "type": "integer", - "description": "Unique identifier for a stepIn target." + "description": "Unique identifier for a step-in target." }, "label": { "type": "string", - "description": "The name of the stepIn target (shown in the UI)." + "description": "The name of the step-in target (shown in the UI)." + }, + "line": { + "type": "integer", + "description": "The line of the step-in target." + }, + "column": { + "type": "integer", + "description": "Start position of the range covered by the step in target. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." + }, + "endLine": { + "type": "integer", + "description": "The end line of the range covered by the step-in target." + }, + "endColumn": { + "type": "integer", + "description": "End position of the range covered by the step in target. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based." } }, "required": [ "id", "label" ] @@ -3643,11 +3864,11 @@ "GotoTarget": { "type": "object", - "description": "A GotoTarget describes a code location that can be used as a target in the 'goto' request.\nThe possible goto targets can be determined via the 'gotoTargets' request.", + "description": "A `GotoTarget` describes a code location that can be used as a target in the `goto` request.\nThe possible goto targets can be determined via the `gotoTargets` request.", "properties": { "id": { "type": "integer", - "description": "Unique identifier for a goto target. This is used in the goto request." + "description": "Unique identifier for a goto target. This is used in the `goto` request." }, "label": { "type": "string", @@ -3659,19 +3880,19 @@ }, "column": { "type": "integer", - "description": "An optional column of the goto target." + "description": "The column of the goto target." }, "endLine": { "type": "integer", - "description": "An optional end line of the range covered by the goto target." + "description": "The end line of the range covered by the goto target." }, "endColumn": { "type": "integer", - "description": "An optional end column of the range covered by the goto target." + "description": "The end column of the range covered by the goto target." }, "instructionPointerReference": { "type": "string", - "description": "Optional memory reference for the instruction pointer value represented by this target." + "description": "A memory reference for the instruction pointer value represented by this target." } }, "required": [ "id", "label", "line" ] @@ -3679,7 +3900,7 @@ "CompletionItem": { "type": "object", - "description": "CompletionItems are the suggestions returned from the CompletionsRequest.", + "description": "`CompletionItems` are the suggestions returned from the `completions` request.", "properties": { "label": { "type": "string", @@ -3687,11 +3908,15 @@ }, "text": { "type": "string", - "description": "If text is not falsy then it is inserted instead of the label." + "description": "If text is returned and not an empty string, then it is inserted instead of the label." }, "sortText": { "type": "string", - "description": "A string that should be used when comparing this item with other items. When `falsy` the label is used." + "description": "A string that should be used when comparing this item with other items. If not returned or an empty string, the `label` is used instead." + }, + "detail": { + "type": "string", + "description": "A human-readable string with additional information about this item, like type or symbol information." }, "type": { "$ref": "#/definitions/CompletionItemType", @@ -3699,19 +3924,19 @@ }, "start": { "type": "integer", - "description": "This value determines the location (in the CompletionsRequest's 'text' attribute) where the completion text is added.\nIf missing the text is added at the location specified by the CompletionsRequest's 'column' attribute." + "description": "Start position (within the `text` attribute of the `completions` request) where the completion text is added. The position is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based. If the start position is omitted the text is added at the location specified by the `column` attribute of the `completions` request." }, "length": { "type": "integer", - "description": "This value determines how many characters are overwritten by the completion text.\nIf missing the value 0 is assumed which results in the completion text being inserted." + "description": "Length determines how many characters are overwritten by the completion text and it is measured in UTF-16 code units. If missing the value 0 is assumed which results in the completion text being inserted." }, "selectionStart": { "type": "integer", - "description": "Determines the start of the new selection after the text has been inserted (or replaced).\nThe start position must in the range 0 and length of the completion text.\nIf omitted the selection starts at the end of the completion text." + "description": "Determines the start of the new selection after the text has been inserted (or replaced). `selectionStart` is measured in UTF-16 code units and must be in the range 0 and length of the completion text. If omitted the selection starts at the end of the completion text." }, "selectionLength": { "type": "integer", - "description": "Determines the length of the new selection after the text has been inserted (or replaced).\nThe selection can not extend beyond the bounds of the completion text.\nIf omitted the length is assumed to be 0." + "description": "Determines the length of the new selection after the text has been inserted (or replaced) and it is measured in UTF-16 code units. The selection can not extend beyond the bounds of the completion text. If omitted the length is assumed to be 0." } }, "required": [ "label" ] @@ -3739,7 +3964,7 @@ }, "checksum": { "type": "string", - "description": "Value of the checksum." + "description": "Value of the checksum, encoded as a hexadecimal value." } }, "required": [ "algorithm", "checksum" ] @@ -3795,15 +4020,15 @@ "ExceptionFilterOptions": { "type": "object", - "description": "An ExceptionFilterOptions is used to specify an exception filter together with a condition for the setExceptionsFilter request.", + "description": "An `ExceptionFilterOptions` is used to specify an exception filter together with a condition for the `setExceptionBreakpoints` request.", "properties": { "filterId": { "type": "string", - "description": "ID of an exception filter returned by the 'exceptionBreakpointFilters' capability." + "description": "ID of an exception filter returned by the `exceptionBreakpointFilters` capability." }, "condition": { "type": "string", - "description": "An optional expression for conditional exceptions.\nThe exception will break into the debugger if the result of the condition is true." + "description": "An expression for conditional exceptions.\nThe exception breaks into the debugger if the result of the condition is true." } }, "required": [ "filterId" ] @@ -3811,14 +4036,14 @@ "ExceptionOptions": { "type": "object", - "description": "An ExceptionOptions assigns configuration options to a set of exceptions.", + "description": "An `ExceptionOptions` assigns configuration options to a set of exceptions.", "properties": { "path": { "type": "array", "items": { "$ref": "#/definitions/ExceptionPathSegment" }, - "description": "A path that selects a single or multiple exceptions in a tree. If 'path' is missing, the whole tree is selected.\nBy convention the first segment of the path is a category that is used to group exceptions in the UI." + "description": "A path that selects a single or multiple exceptions in a tree. If `path` is missing, the whole tree is selected.\nBy convention the first segment of the path is a category that is used to group exceptions in the UI." }, "breakMode": { "$ref": "#/definitions/ExceptionBreakMode", @@ -3836,7 +4061,7 @@ "ExceptionPathSegment": { "type": "object", - "description": "An ExceptionPathSegment represents a segment in a path that is used to match leafs or nodes in a tree of exceptions.\nIf a segment consists of more than one name, it matches the names provided if 'negate' is false or missing or\nit matches anything except the names provided if 'negate' is true.", + "description": "An `ExceptionPathSegment` represents a segment in a path that is used to match leafs or nodes in a tree of exceptions.\nIf 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.", "properties": { "negate": { "type": "boolean", @@ -3847,7 +4072,7 @@ "items": { "type": "string" }, - "description": "Depending on the value of 'negate' the names that should match or not match." + "description": "Depending on the value of `negate` the names that should match or not match." } }, "required": [ "names" ] @@ -3871,7 +4096,7 @@ }, "evaluateName": { "type": "string", - "description": "Optional expression that can be evaluated in the current scope to obtain the exception object." + "description": "An expression that can be evaluated in the current scope to obtain the exception object." }, "stackTrace": { "type": "string", @@ -3893,11 +4118,11 @@ "properties": { "address": { "type": "string", - "description": "The address of the instruction. Treated as a hex value if prefixed with '0x', or as a decimal value otherwise." + "description": "The address of the instruction. Treated as a hex value if prefixed with `0x`, or as a decimal value otherwise." }, "instructionBytes": { "type": "string", - "description": "Optional raw bytes representing the instruction and its operands, in an implementation-defined format." + "description": "Raw bytes representing the instruction and its operands, in an implementation-defined format." }, "instruction": { "type": "string", @@ -3933,7 +4158,7 @@ "InvalidatedAreas": { "type": "string", - "description": "Logical areas that can be invalidated by the 'invalidated' event.", + "description": "Logical areas that can be invalidated by the `invalidated` event.", "_enum": [ "all", "stacks", "threads", "variables" ], "enumDescriptions": [ "All previously fetched data has become invalid and needs to be refetched.",