diff options
Diffstat (limited to 'packages/bun-debug-adapter-protocol')
3 files changed, 33 insertions, 11 deletions
diff --git a/packages/bun-debug-adapter-protocol/scripts/generate-protocol.ts b/packages/bun-debug-adapter-protocol/scripts/generate-protocol.ts index 51b2765b5..41847c6db 100644 --- a/packages/bun-debug-adapter-protocol/scripts/generate-protocol.ts +++ b/packages/bun-debug-adapter-protocol/scripts/generate-protocol.ts @@ -5,7 +5,7 @@ import { spawnSync } from "node:child_process"; run().catch(console.error); async function run() { - const cwd = new URL("../protocol/", import.meta.url); + const cwd = new URL("../src/protocol/", import.meta.url); const runner = "Bun" in globalThis ? "bunx" : "npx"; const write = (name: string, data: string) => { const path = new URL(name, cwd); diff --git a/packages/bun-debug-adapter-protocol/src/protocol/index.d.ts b/packages/bun-debug-adapter-protocol/src/protocol/index.d.ts index abf9ecdec..7a8dcc312 100644 --- a/packages/bun-debug-adapter-protocol/src/protocol/index.d.ts +++ b/packages/bun-debug-adapter-protocol/src/protocol/index.d.ts @@ -638,7 +638,7 @@ export namespace DAP { */ export type BreakpointLocationsRequest = { /** - * 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. */ source: Source; /** @@ -1139,6 +1139,12 @@ export namespace DAP { * The value should be less than or equal to 2147483647 (2^31-1). */ indexedVariables?: number; + /** + * 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 may be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true. + */ + memoryReference?: string; }; /** * Arguments for `source` request. @@ -1286,7 +1292,7 @@ export namespace DAP { /** * 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 corresponding capability `supportsMemoryReferences` is true. + * This attribute may be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true. */ memoryReference?: string; }; @@ -1344,6 +1350,12 @@ export namespace DAP { * The value should be less than or equal to 2147483647 (2^31-1). */ indexedVariables?: number; + /** + * 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 may be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true. + */ + memoryReference?: string; }; /** * Arguments for `stepInTargets` request. @@ -2064,8 +2076,10 @@ export namespace DAP { */ indexedVariables?: number; /** - * The memory reference for the variable if the variable represents executable code, such as a function pointer. - * This attribute is only required if the corresponding capability `supportsMemoryReferences` is true. + * A memory reference associated with this variable. + * For pointer type variables, this is generally a reference to the memory address contained in the pointer. + * For executable data, this reference may later be used in a `disassemble` request. + * This attribute may be returned by a debug adapter if corresponding capability `supportsMemoryReferences` is true. */ memoryReference?: string; }; diff --git a/packages/bun-debug-adapter-protocol/src/protocol/protocol.json b/packages/bun-debug-adapter-protocol/src/protocol/protocol.json index 00a2ab014..41d65608e 100644 --- a/packages/bun-debug-adapter-protocol/src/protocol/protocol.json +++ b/packages/bun-debug-adapter-protocol/src/protocol/protocol.json @@ -108,7 +108,7 @@ { "$ref": "#/definitions/Request" }, { "type": "object", - "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.", + "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.", "properties": { "command": { "type": "string", "enum": ["cancel"] }, "arguments": { "$ref": "#/definitions/CancelArguments" } @@ -1074,7 +1074,7 @@ "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." }, "line": { "type": "integer", @@ -2035,6 +2035,10 @@ "indexedVariables": { "type": "integer", "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": "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." } }, "required": ["value"] @@ -2326,7 +2330,7 @@ }, "memoryReference": { "type": "string", - "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." + "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." } }, "required": ["result", "variablesReference"] @@ -2397,6 +2401,10 @@ "indexedVariables": { "type": "integer", "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": "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." } }, "required": ["value"] @@ -3240,7 +3248,7 @@ }, "memoryReference": { "type": "string", - "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." + "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." } }, "required": ["name", "value", "variablesReference"] @@ -3299,8 +3307,8 @@ "Indicates that the object is a constant.", "Indicates that the object is read only.", "Indicates that the object is a raw string.", - "Indicates that the object can have an Object ID created for it.", - "Indicates that the object has an Object ID associated with it.", + "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.", + "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.", "Indicates that the evaluation had side effects.", "Indicates that the object has its value tracked by a data breakpoint." ] |