Clarify impact of StackFrameFormat #411

Activity

1. connor4312 commented on Jul 27, 2023

   

   Connor Peet (connor4312)

   on Jul 27, 2023

   Member

   More actions

   I'm not sure actually. Gregg Miskelly (@gregg-miskelly) do you have historical context on this one?
2. Connor Peet (connor4312)

   added

   under-discussionIssue is under discussion for relevance, priority, approachIssue is under discussion for relevance, priority, approach

   on Jul 27, 2023
3. gregg-miskelly commented on Jul 27, 2023

   

   Gregg Miskelly (gregg-miskelly)

   on Jul 27, 2023

   Member

   More actions

   My guess is that many of the parameters ought to affect the name of the returned stack frame. It would be great if the spec could spell this out.

   Correct

   Some parameters, like line and module, seem redundant, though. And even parameterValues seems redundant with the scopes request.

   By "redundant" do you mean the client could produce the name itself in some way? If so, that is correct, but it is done this way so that:

   1. The debug adapter can format the string in a syntax that makes sense in their language
      -and-
   2. The debug adapter may be able to far more efficiently produce the value of just the arguments to the function than the using a scopes request
4. tromey commented on Jul 28, 2023

   

   Tom Tromey (tromey)

   on Jul 28, 2023

   Author

   More actions

   By "redundant" do you mean the client could produce the name itself in some way?

   I just meant that the line and module are already present in the StackFrame, so I didn't understand if this flag means the client is required to also put the information into name.
5. connor4312 commented on Jul 28, 2023

   

   Connor Peet (connor4312)

   on Jul 28, 2023

   Member

   More actions

   Thanks for the context. I suggest replacing "for the stack frame" to "in the StackFrame.name" for the relevant properties.
6. Connor Peet (connor4312)

   self-assigned this

   on Jul 28, 2023
7. Connor Peet (connor4312)

   added

   clarificationProtocol clarificationProtocol clarification

   and removed

   under-discussionIssue is under discussion for relevance, priority, approachIssue is under discussion for relevance, priority, approach

   on Jul 28, 2023
8. tromey commented on Oct 6, 2023

   

   Tom Tromey (tromey)

   on Oct 6, 2023

   Author

   More actions

   A related question here is what does parameters mean -- how does it differ from parameterTypes, parameterNames, and parameterValues?
9. gregg-miskelly commented on Oct 6, 2023

   

   Gregg Miskelly (gregg-miskelly)

   on Oct 6, 2023

   Member

   More actions

   I think it was a mistake to include parameters. I believe the author of this part of the spec was borrowing too heavily from Visual Studio's debug interface (FIF_FUNCNAME_ARGS) but here is how I believe this was intended to work:

   • parameters == false: Don't indicate anything about the parameters to the method. Debugger doesn't need to even look at parameterTypes, parameterNames or parameterValues
   • parameters == true: Include the arguments in a way that makes sense for the language being debugged, using parameterTypes, parameterNames, and parameterValues as makes sense

   👍React with 👍1Reacted by Tom Tromey
10. JustinGrote commented on Oct 12, 2024

    

    Justin Grote (JustinGrote)

    on Oct 12, 2024

    More actions

    Sorry to necro this thread, but I was curious in regards to the parameters surfacing, what about the actual values/arguments specified to those parameters?

    For example if I have this call stack:
    

    Not sure where I am supposed to surface those Argument values, since it's not a property on the StackTrace itself or the Source
11. connor4312 commented on Oct 25, 2024

    

    Connor Peet (connor4312)

    on Oct 25, 2024

    Member

    More actions

    The guidance would be to put them in the StackFrame.name in a 'way that makes sense' for users of the DA.

    If I had my druthers, it would be a bit more structured, but we are where we are.

    I will make a PR to clarify StackFrameFormat a bit.
12. Connor Peet (connor4312)

    added this to the November 2024 milestone on Oct 25, 2024
13. Connor Peet (connor4312)

    added a commit that references this issue on Oct 25, 2024

    fix: clarify how StackTraceArguments.format applies

    ...

    This issue will close once commit e813a29 is merged into the 'main' branch.

    e813a29
14. Connor Peet (connor4312)

    closed this as completedin #510on Oct 30, 2024
15. Connor Peet (connor4312)

    added a commit that references this issue on Oct 30, 2024

    fix: clarify how StackTraceArguments.format applies (#510)

    ...

    This issue will close once commit 155d2bb is merged into the 'main' branch.

    155d2bb
16. JustinGrote commented on Oct 30, 2024

    

    Justin Grote (JustinGrote)

    on Oct 30, 2024

    More actions

    Thank you!