🚥 Implement Document Highlight for all return / throws (function/closure/accessor/init/deinit) and break / continue (for/while/repeat...while) #2403
Conversation
…e/accessor/init/deinit) and break / continue (for/while/repeat...while)
lokesh-tr
changed the title
|
This is how it looks: 
|
ahoppen
left a comment
ahoppen
left a comment
There was a problem hiding this comment.
Very nice and excited for this. 😍
A preliminary review, as you already noted in the PR description, a few tests would be good 😉
| if node.lookupControlStructure() == targetStructure { | ||
| highlights.append( | ||
| DocumentHighlight( | ||
| range: snapshot.absolutePositionRange(of: node.positionAfterSkippingLeadingTrivia..<node.endPosition), |
There was a problem hiding this comment.
Should we just highlight the control flow keyword (eg. return). I think that might look nicer, especially if the returned expression spans multiple lines.
| return nil | ||
| } | ||
|
|
||
| guard let targetStructure = Syntax(tokenSyntax).parent!.lookupControlStructure() else { |
There was a problem hiding this comment.
We shouldn’t force unwrap the parent here.
| } | ||
| } | ||
|
|
||
| private func documentSymbolHighlightHelper( |
There was a problem hiding this comment.
I would give this a more descriptive name which highlights that this is about control flow keyword highlighting.
| } | ||
| } | ||
|
|
||
| override func visit(_ node: BreakStmtSyntax) -> SyntaxVisitorContinueKind { |
There was a problem hiding this comment.
You shouldn’t need to repeat the list of control flow nodes if this is a SyntaxAnyVisitor and you add a visitAny override.
2 participants
Upgrades
textDocument/documentHighlightto highlight various return / throw statements corresponding to a function / closure / accessor / init / deinit, and break / continue statements corresponding to a loop, thereby allowing us to not wonder about which statements could cause an exit from a function or loop.This also makes use of a new API introduced in SwiftLexicalLookup Library in Swift Syntax.
This doesn't break existing code. This is Additive.
Fixes: Highlight related identifiers for control flow keywords #2400
This is the original PR. New API for Swift Syntax introduced in 🚥 Introduce a new Lexical query
lookupControlStructureto theSwiftLexicalLookupLibrary swift-syntax#3216I don't think there's any risk associated with this new feature.
Tests and Docs are yet to be written. The code & This PR description will also be polished.
Suggested by @ahoppen and Open to be reviewed by anyone. Note: At the current state, the code is messy since I was focused on getting it to work, will polish it.