[lldb] Fix Language Plugin decl printing #6795
Merged
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
Author
|
@swift-ci test |
Author
|
Will update with test coverage. |
|
This looks like it should be an upstream change? |
Author
|
It should be yes, but the test won't be. I thought I'd do it here with the test and then add the code change to upstream. Thoughts? |
Author
|
@swift-ci test |
adrian-prantl
approved these changes
May 5, 2023
| let object = Object() | ||
| _ = object // break here | ||
| let user = User() | ||
| // break here |
Author
There was a problem hiding this comment.
I was under the impression that the following line (_ = (object, user)) has the same safety effect as the print would. Is that not the case?
There was a problem hiding this comment.
I'm sure it works fine now. A (future) compiler could decide to optimize away the assignment, but not an i/o call.
|
You might be able to sell it as an NFC patch upstream |
Author
|
@swift-ci test |
Author
|
@swift-ci test windows |
kastiglione
commented
May 8, 2023
| ConstString type_name_cstr(typeName.GetString()); | ||
| ConstString var_name_cstr(varName.GetString()); | ||
|
|
||
| DumpValueObjectOptions decl_print_options; |
Author
There was a problem hiding this comment.
Mistake: this should be copy construction from m_options. New PR to follow.
Author
|
kastiglione
added a commit
that referenced
this pull request
May 8, 2023
Correction to #6795. This should be a copy constructed instance.
kastiglione
added a commit
that referenced
this pull request
May 9, 2023
`SwiftLanguage::GetDeclPrintingHelper` is a helper function used for Swift types. This
code contains some very similar logic to the default logic in `ValueObjectPrinter`.
Specifically:
`SwiftLanguage`:
```c++
else if (!options.m_hide_name)
stream.Printf(" =");
```
`ValueObjectPrinter`:
```c++
else if (ShouldShowName())
m_stream->Printf(" =");
```
The function `ValueObjectPrinter::ShouldShowName` is not accessible by `SwiftLanguage`.
To allow `SwiftLanguage` to make the right decision, and fit within the existing API
boundary, this change uses a custom print options, which sets calls `SetHideName`
according to the value of `ShouldShowName()`. This allows the Swift language decl
printing helper to correctly know whether to print the name, or not.
(cherry-picked from commit e6d9bd6)
kastiglione
added a commit
that referenced
this pull request
May 9, 2023
`SwiftLanguage::GetDeclPrintingHelper` is a helper function used for Swift types. This
code contains some very similar logic to the default logic in `ValueObjectPrinter`.
Specifically:
`SwiftLanguage`:
```c++
else if (!options.m_hide_name)
stream.Printf(" =");
```
`ValueObjectPrinter`:
```c++
else if (ShouldShowName())
m_stream->Printf(" =");
```
The function `ValueObjectPrinter::ShouldShowName` is not accessible by `SwiftLanguage`.
To allow `SwiftLanguage` to make the right decision, and fit within the existing API
boundary, this change uses a custom print options, which sets calls `SetHideName`
according to the value of `ShouldShowName()`. This allows the Swift language decl
printing helper to correctly know whether to print the name, or not.
(cherry-picked from commit e6d9bd6)
kastiglione
added a commit
that referenced
this pull request
May 9, 2023
kastiglione
added a commit
that referenced
this pull request
May 9, 2023
kastiglione
added a commit
to llvm/llvm-project
that referenced
this pull request
May 15, 2023
When `ValueObjectPrinter` calls its `m_decl_printing_helper`, not all state is passed to the helper. In particular, the helper doesn't have access to `m_curr_depth`, and thus can't act on the logic within `ShouldShowName`. To address this, this change passes in a modified copy of `m_options`. The modified copy has has `m_hide_name` set according to the results of `ShouldShowName`. This allows helper functions to know whether the name should be shown or hidden, without having access to `ValueObjectPrinter`'s full state. This is NFC in mainline lldb, as the only decl printing helper doesn't make use of this. However in swift-lldb at least, there are decl printing helpers that do need this information passed to them. See swiftlang#6795 where a test is also included. Differential Revision: https://reviews.llvm.org/D150129
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
SwiftLanguage::GetDeclPrintingHelperis a helper function used for Swift types. This code contains some very similar logic to the default logic inValueObjectPrinter. Specifically:SwiftLanguage:ValueObjectPrinter:The function
ValueObjectPrinter::ShouldShowNameis not accessible bySwiftLanguage.To allow
SwiftLanguageto make the right decision, and fit within the existing API boundary, this change uses a custom print options, which sets callsSetHideNameaccording to the value ofShouldShowName(). This allows the Swift language decl printing helper to correctly know whether to print the name, or not.