feat: add instruction reference to GotoTargets request
#578
+43
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
connor4312
reviewed
Dec 16, 2025
debugAdapterProtocol.json
Outdated
| }, | ||
| "offset": { | ||
| "type": "integer", | ||
| "description": "The offset from the instruction reference in bytes.\nThis can be negative. Clients may set this property only if the `supportsGotoInstruction` is true." |
Member
There was a problem hiding this comment.
Suggested change
| "description": "The offset from the instruction reference in bytes.\nThis can be negative. Clients may set this property only if the `supportsGotoInstruction` is true." | |
| "description": "The offset from the instruction reference in bytes.\nThis can be negative. This may only be provided when an `instructionReference` is included in the request." |
debugAdapterProtocol.json
Outdated
| }, | ||
| "instructionReference": { | ||
| "type": "string", | ||
| "description": "The instruction reference for which the goto targets are determined.\nThis should be a memory or instruction pointer reference from an `EvaluateResponse`, `Variable`, `StackFrame`, `GotoTarget`, or `Breakpoint`. Clients may set this property only if the `supportsGotoInstruction` is true." |
Member
There was a problem hiding this comment.
I'd do something like...
Suggested change
| "description": "The instruction reference for which the goto targets are determined.\nThis should be a memory or instruction pointer reference from an `EvaluateResponse`, `Variable`, `StackFrame`, `GotoTarget`, or `Breakpoint`. Clients may set this property only if the `supportsGotoInstruction` is true." | |
| "description": "The instruction reference for which the goto targets are determined.\nThis should be a memory or instruction pointer reference from an `EvaluateResponse`, `Variable`, `StackFrame`, `GotoTarget`, or `Breakpoint`. Clients may set this property only if the `supportsGotoInstruction` is true. If `instructionReference` is set, the debug adapter should ignore the `line`, `column`, and `source` on the request and clients may set them to zero or empy values." |
Unfortunately making them actually optional in the types is an interface-breaking change.
debugAdapterProtocol.json
Outdated
| "type": "boolean", | ||
| "description": "The debug adapter supports ANSI escape sequences in styling of `OutputEvent.output` and `Variable.value` fields." | ||
| }, | ||
| "supportsGotoInstruction": { |
Member
There was a problem hiding this comment.
I would name this supportsGotoInstructionTargets just in case we ever have another type of 'go to' action
DrSergei
force-pushed
the
add-instruction-reference
branch
from
c1e87e7 to
f00c30f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #577
I added this feature based on the
instuctionRefenence+offsetpair, similar to thesetInstuctionBreakpointrequest. I don't know what to do with existing required fields (sourceandline). It looks like that client could set them based on the selected stack frame. And the debug adapter should be able to resolve the selected instruction to the correct location. WDYT?