|
130 | 130 | "CancelRequest": { |
131 | 131 | "allOf": [ { "$ref": "#/definitions/Request" }, { |
132 | 132 | "type": "object", |
133 | | - "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.", |
| 133 | + "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.\nClients 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.", |
134 | 134 | "properties": { |
135 | 135 | "command": { |
136 | 136 | "type": "string", |
|
1202 | 1202 | "properties": { |
1203 | 1203 | "source": { |
1204 | 1204 | "$ref": "#/definitions/Source", |
1205 | | - "description": "The source location of the breakpoints; either `source.path` or `source.reference` must be specified." |
| 1205 | + "description": "The source location of the breakpoints; either `source.path` or `source.sourceReference` must be specified." |
1206 | 1206 | }, |
1207 | 1207 | "line": { |
1208 | 1208 | "type": "integer", |
|
1414 | 1414 | "SetExceptionBreakpointsResponse": { |
1415 | 1415 | "allOf": [ { "$ref": "#/definitions/Response" }, { |
1416 | 1416 | "type": "object", |
1417 | | - "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.", |
| 1417 | + "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 is 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.", |
1418 | 1418 | "properties": { |
1419 | 1419 | "body": { |
1420 | 1420 | "type": "object", |
|
1477 | 1477 | "properties": { |
1478 | 1478 | "dataId": { |
1479 | 1479 | "type": [ "string", "null" ], |
1480 | | - "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." |
| 1480 | + "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. If a `variablesReference` or `frameId` is passed, the `dataId` is valid in the current suspended state, otherwise it's valid indefinitely. See 'Lifetime of Object References' in the Overview section for details. Breakpoints set using the `dataId` in the `setDataBreakpoints` request may outlive the lifetime of the associated `dataId`." |
1481 | 1481 | }, |
1482 | 1482 | "description": { |
1483 | 1483 | "type": "string", |
|
2228 | 2228 | "indexedVariables": { |
2229 | 2229 | "type": "integer", |
2230 | 2230 | "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)." |
| 2231 | + }, |
| 2232 | + "memoryReference": { |
| 2233 | + "type": "string", |
| 2234 | + "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 may be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true." |
2231 | 2235 | } |
2232 | 2236 | }, |
2233 | 2237 | "required": [ "value" ] |
|
2545 | 2549 | }, |
2546 | 2550 | "memoryReference": { |
2547 | 2551 | "type": "string", |
2548 | | - "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." |
| 2552 | + "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 may be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true." |
2549 | 2553 | } |
2550 | 2554 | }, |
2551 | 2555 | "required": [ "result", "variablesReference" ] |
|
2625 | 2629 | "indexedVariables": { |
2626 | 2630 | "type": "integer", |
2627 | 2631 | "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)." |
| 2632 | + }, |
| 2633 | + "memoryReference": { |
| 2634 | + "type": "string", |
| 2635 | + "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 may be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true." |
2628 | 2636 | } |
2629 | 2637 | }, |
2630 | 2638 | "required": [ "value" ] |
|
3587 | 3595 | }, |
3588 | 3596 | "memoryReference": { |
3589 | 3597 | "type": "string", |
3590 | | - "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." |
| 3598 | + "description": "A memory reference associated with this variable.\nFor pointer type variables, this is generally a reference to the memory address contained in the pointer.\nFor executable data, this reference may later be used in a `disassemble` request.\nThis attribute may be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true." |
3591 | 3599 | } |
3592 | 3600 | }, |
3593 | 3601 | "required": [ "name", "value", "variablesReference" ] |
|
3626 | 3634 | "Indicates that the object is a constant.", |
3627 | 3635 | "Indicates that the object is read only.", |
3628 | 3636 | "Indicates that the object is a raw string.", |
3629 | | - "Indicates that the object can have an Object ID created for it.", |
3630 | | - "Indicates that the object has an Object ID associated with it.", |
| 3637 | + "Indicates that the object can have an Object ID created for it. This is a vestigial attribute that is used by some clients; 'Object ID's are not specified in the protocol.", |
| 3638 | + "Indicates that the object has an Object ID associated with it. This is a vestigial attribute that is used by some clients; 'Object ID's are not specified in the protocol.", |
3631 | 3639 | "Indicates that the evaluation had side effects.", |
3632 | 3640 | "Indicates that the object has its value tracked by a data breakpoint." |
3633 | 3641 | ] |
|
0 commit comments