Inlay hints support #22896

nickysn · 2023-10-31T13:44:54Z

This adds inlay hints support to nimsuggest. It adds a new command to nimsuggest, called 'inlayHints'.

Currently, it provides type information to 'var' and 'let' variables. In the future, inlay hints can also be added for 'const' and for function parameters. The protocol also reserves space for a tooltip field, which is not used, yet, but support for it can be added in the future, without further changing the protocol.

The change includes refactoring to allow the 'inlayHints' command to return a completely different structure, compared to the other nimsuggest commands. This will allow other future commands to have custom return types as well. All the previous commands return the same structure as before, so perfect backwards compatibility is maintained.

To use this feature, an update to the nim language server, as well as the VS code extension is needed.

Related PRs:
nimlangserver: nim-lang/langserver#53
VS code extension: saem/vscode-nim#134

…uggest

…d to the suggestSym proc. Only show inlay suggest hints for symbols with isDecl = true.

…fied explicitly. We use this to avoid returning inlay type hints for vars that have already a type, specified in code.

different (custom) structure.

… future use, without changing the nimsuggest protocol for the result of the inlayHints command)

nickysn · 2023-10-31T15:12:19Z

CI failure is because nimlsp uses structures from the compiler sources. Suggest is now a base class, with multiple descendants, and all the members of what was previously Suggest are now in SuggestDef. Nimlsp needs to be updated in order to compile against the new compiler sources. Note that there's no change in the nimsuggest protocol, so already compiled versions of nimlsp should work with the new nimsuggest.

Araq · 2023-10-31T17:48:31Z

I assume it's easier to keep backwards compatibility when you do away with the newly introduced inheritance? The added fields are nothing to worry about anyway.

…order to keep compatiblity with existing nimsuggest clients, that use the nimsuggest structures from the compiler sources as a library.

…e Suggest object

… when the position is in the first or last line)

…, because Nim doesn't support declaring a variable type for 'for' loops

nickysn · 2023-11-02T06:39:11Z

Ok, got rid of the inheritance. The remaining CI failure looks like a random glitch and unrelated to my changes.

…(they have a `gensym appended to their name, internally)

Araq · 2023-11-03T22:11:57Z

compiler/suggest.nim

@@ -105,7 +105,7 @@ proc getTokenLenFromSource(conf: ConfigRef; ident: string; info: TLineInfo): int
      result = 0
  elif ident[0] in linter.Letters and ident[^1] != '=':
    result = identLen(line, column)
-    if cmpIgnoreStyle(line[column..column + result - 1], ident) != 0:
+    if cmpIgnoreStyle(line[column..column + result - 1], ident[0..min(result-1,len(ident)-1)]) != 0:


Because ident may have extra stuff appended when part of a template. E.g. when a variable is part of a template, "`gensymXXX" is appended, where XXX are some numbers. In the previous version of the code, this would return a token length of 0. In turn, this causes the inlay hint to be put in the wrong place. Instead of:

template benchmark(benchmarkName: string, code: untyped) = block: debug "Started...", benchmark = benchmarkName let t0: float = epochTime() code let elapsed: float = epochTime() - t0 let elapsedStr: string = elapsed.formatFloat(format = ffDecimal, precision = 3) debug "CPU Time", benchmark = benchmarkName, time = elapsedStr

You would get:

template benchmark(benchmarkName: string, code: untyped) = block: debug "Started...", benchmark = benchmarkName let : floatt0 = epochTime() code let : floatelapsed = epochTime() - t0 let : stringelapsedStr = elapsed.formatFloat(format = ffDecimal, precision = 3) debug "CPU Time", benchmark = benchmarkName, time = elapsedStr

Sucks, but ok.

compiler/suggest.nim

nimsuggest/nimsuggest.nim

Co-authored-by: Andreas Rumpf <[email protected]>

github-actions · 2023-11-04T07:55:33Z

Thanks for your hard work on this PR!
The lines below are statistics of the Nim compiler built from 3f2b9c8

Hint: mm: orc; opt: speed; options: -d:release
176413 lines; 7.168s; 767.852MiB peakmem

This adds inlay hints support to nimsuggest. It adds a new command to nimsuggest, called 'inlayHints'. Currently, it provides type information to 'var' and 'let' variables. In the future, inlay hints can also be added for 'const' and for function parameters. The protocol also reserves space for a tooltip field, which is not used, yet, but support for it can be added in the future, without further changing the protocol. The change includes refactoring to allow the 'inlayHints' command to return a completely different structure, compared to the other nimsuggest commands. This will allow other future commands to have custom return types as well. All the previous commands return the same structure as before, so perfect backwards compatibility is maintained. To use this feature, an update to the nim language server, as well as the VS code extension is needed. Related PRs: nimlangserver: nim-lang/langserver#53 VS code extension: saem/vscode-nim#134 --------- Co-authored-by: Andreas Rumpf <[email protected]> (cherry picked from commit 3f2b9c8)

nickysn added 6 commits October 26, 2023 04:33

initial (and still, very rough) attempt at adding inlay hints to nims…

824eb48

…uggest

Store inside the SymInfoPair the value of the isDecl parameter, passe…

ad6200b

…d to the suggestSym proc. Only show inlay suggest hints for symbols with isDecl = true.

Added nimsuggest-specific flag whether a declaration has a type speci…

508f3b2

…fied explicitly. We use this to avoid returning inlay type hints for vars that have already a type, specified in code.

Changed the response to the new 'inlayHints' nimsuggest command to be a

a2c84d9

different (custom) structure.

Added allowInsert flag to SuggestInlayHint

067ffee

Added tooltip field to SuggestInlayHint (not used for now, but allows…

c2403f0

… future use, without changing the nimsuggest protocol for the result of the inlayHints command)

nickysn mentioned this pull request Oct 31, 2023

Inlay hints support nim-lang/langserver#53

Merged

nickysn added 4 commits November 1, 2023 10:43

Moved the fields of SuggestDef back into the Suggest base object, in …

39a3ee2

…order to keep compatiblity with existing nimsuggest clients, that use the nimsuggest structures from the compiler sources as a library.

Embed, instead of using inheritance for storing the inlay hints in th…

f4dabb1

…e Suggest object

Proper implementation of the inRange function (also checks the column…

994a8d4

… when the position is in the first or last line)

Disallow 'double click to insert' for inlay hints for 'for' variables…

191a1ce

…, because Nim doesn't support declaring a variable type for 'for' loops

nickysn added 2 commits November 3, 2023 13:21

Fixed inlay hints location for variables, declared inside a template …

cdbc3c9

…(they have a `gensym appended to their name, internally)

Fixed potential range check error, introduced by the previous commit

63d7e11

Araq reviewed Nov 3, 2023

View reviewed changes

compiler/suggest.nim Outdated Show resolved Hide resolved

Araq reviewed Nov 3, 2023

View reviewed changes

compiler/suggest.nim Outdated Show resolved Hide resolved

Araq reviewed Nov 3, 2023

View reviewed changes

nimsuggest/nimsuggest.nim Outdated Show resolved Hide resolved

Araq and others added 3 commits November 3, 2023 23:17

Update compiler/suggest.nim

71b9b74

Update nimsuggest/nimsuggest.nim

8f9eb9a

Update compiler/suggest.nim

38a732a

Co-authored-by: Andreas Rumpf <[email protected]>

Araq merged commit 3f2b9c8 into nim-lang:devel Nov 4, 2023
19 checks passed

nickysn deleted the inlay_hints_support branch November 6, 2023 11:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inlay hints support #22896

Inlay hints support #22896

nickysn commented Oct 31, 2023 •

edited

Loading

nickysn commented Oct 31, 2023 •

edited

Loading

Araq commented Oct 31, 2023

nickysn commented Nov 2, 2023

Araq Nov 3, 2023

nickysn Nov 4, 2023

Araq Nov 4, 2023

github-actions bot commented Nov 4, 2023

Inlay hints support #22896

Inlay hints support #22896

Conversation

nickysn commented Oct 31, 2023 • edited Loading

nickysn commented Oct 31, 2023 • edited Loading

Araq commented Oct 31, 2023

nickysn commented Nov 2, 2023

Araq Nov 3, 2023

Choose a reason for hiding this comment

nickysn Nov 4, 2023

Choose a reason for hiding this comment

Araq Nov 4, 2023

Choose a reason for hiding this comment

github-actions bot commented Nov 4, 2023

nickysn commented Oct 31, 2023 •

edited

Loading

nickysn commented Oct 31, 2023 •

edited

Loading