Fix negative active signature/parameter #547
Merged
Conversation
This file contains 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
fwcd
reviewed
Jan 16, 2024
server/src/main/kotlin/org/javacs/kt/signaturehelp/SignatureHelp.kt
Outdated
Show resolved
Hide resolved
fwcd
reviewed
Jan 18, 2024
server/src/main/kotlin/org/javacs/kt/signaturehelp/SignatureHelp.kt
Outdated
Show resolved
Hide resolved
| val (signatures, activeDeclaration, activeParameter) = getSignatureTriplet(file, cursor) ?: return nullResult("No call around ${file.describePosition(cursor)}") | ||
| return SignatureHelp(signatures, activeDeclaration, activeParameter) | ||
| val (signatures, activeSignature, activeParameter) = getSignatureTriplet(file, cursor) ?: return nullResult("No call around ${file.describePosition(cursor)}") | ||
| return SignatureHelp(signatures, activeSignature,activeParameter) |
There was a problem hiding this comment.
Style nit
Suggested change
| return SignatureHelp(signatures, activeSignature,activeParameter) | |
| return SignatureHelp(signatures, activeSignature, activeParameter) |
There was a problem hiding this comment.
@fwcd yeah sorry I didn't use any formatter, as this file seems to be unformatted, and If I used the formatter of kotlin-language-server it formatted multiple lines, and I didn't want to make the diff of my changes unneedlessly large.
|
@fwcd No rush, but just to clarify, the PR should be ready for review again. |
|
Thanks! |
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.
I'm using the Helix Editor and when I put my cursor inside a string, and request the help signature it throws an error that
-1is an invalid value for u32. (helix is written in Rust)I took a look at the Language Server Protocol Spec and saw that the
activeSignatureandactiveParameterare unsigned Integers according to the spec, so the implementation in helix seems to be correct.This means these functions should never return a value below 0.
My change sets the activeParameter/activeSignature to
nullif the value is not greater-equals 0, which omits the activeSignature/activeParameter value in the response, as the spec allows, which helix happily accepts. (Helix sets them to the default value of0if the values are null or omitted see here and here)(I've never written any Kotlin code, so feel free to recommend other ways to implement this)
Alternatives
With my change it is up to the client to choose the signature and parameter, and as the spec mentions,
[...] In future version of the protocol, this property might become mandatory to better express this., this change may not be valid in future versions. The alternative would be to return 0 for both functions, if they don't return a value greater-equals than 0.