Add unsafe RawPresentationCompiler implementation #24133
Conversation
…iver will now check for Thread.isInterrupted cancellation
| LabelPart(": ") :: toLabelParts(tpe, pos), | ||
| InlayHintKind.Type, | ||
| ) | ||
| .addDefinition(adjustedPos.start) |
There was a problem hiding this comment.
It was removed out of sudden in Scala 2 presentation compiler, I believe it is no longer necessary as we're deduplicating inlay hints during add
| | | ||
| |def test/*: (path : String<<java/lang/String#>>, num : Int<<scala/Int#>>, line : Int<<scala/Int#>>)*/ = | ||
| | hello ++/*[Tuple1<<scala/Tuple1#>>["line"], Tuple1<<scala/Tuple1#>>[Int<<scala/Int#>>]]*/ (line = 1)/*(using refl<<scala/`<:<`.refl().>>)*//*[Tuple1<<scala/Tuple1#>>[Int<<scala/Int#>>]]*/ | ||
| | hello ++/*[Tuple1<<scala/Tuple1#>>["line"], Tuple1<<scala/Tuple1#>>[Int<<scala/Int#>>]]*/ (line = 1)/*[Tuple1<<scala/Tuple1#>>[Int<<scala/Int#>>]]*//*(using refl<<scala/`<:<`.refl().>>)*/ |
There was a problem hiding this comment.
Caused by mtags version bump
| } | ||
|
|
||
| tree match |
There was a problem hiding this comment.
TLDR: I think that it's fine to patch only the necessary changes for now, but this should probably be refactored (similarly as Scala 2 code) soon-ish.
The refactor in the Scala 2 PC was meant to allow for more than one "case" to be executed here. This isn't a problem yet, since scalameta/metals#7815 hasn't been ported yet. Though one could make an argument that this problem appeared before and was "hacked" my merging implementations for two inlay hint types.
The idea behind the refactor is:
- We move the logic from the branches in this match into private methods on appropriate Inlay-Hint-providing-objects.
- Afterwards, this method is simplified to a
foldLeftthrough all the cases. - Every Inlay-Hint-providing-objects returns its inlay hints in separation, and we merge them together for every tree.
- Afterwards, they can be deduplicated (right now only for InferredType) – this separates generation and deduplication.
I think that a similar refactor should be done here as well, though it maybe shouldn't be part of this PR.
| import org.eclipse.lsp4j as l | ||
|
|
||
|
|
||
| case class RawScalaPresentationCompiler( |
There was a problem hiding this comment.
Could you add a comment that explains the purpose of this class?
RawPresentationCompileris a direct, unsafe way to access presentation compiler interface provided inscalameta/metals#7841
It is up to the consumer to guarantee thread safety and sequential request processing.
This solves many issues with the current
PresentationCompilerinterface but most important are:SingleThreadExecutorcreated by thePresentationCompiler. The original behavior will stay with the standardScalaPresentationCompilerinterface. (There is another PR that refactors that part),On top of that this PR implements all things that will work out of the box:
Scala3CompilerAccess. Will be super useful e.g for Scastie which will become a consumer of this new raw API.InteractiveDrivercompilation cancellation by checking Thread.interrupted(). Future changes are required to make it work with safeScalaPresentationCompilerandCancelTokens. Here we can omit the cancel token support for now, because we would check forThread.interrupted()along thecancelToken.isCancelledanyway, and we can now easily interrupt it from e.gIO.interruptibleThose changes were adapted from my other PR's that required adjustment of
Scala3CompilerAccessbut I don't think it is ready / I'm not happy with current state of that refactor.In the future we should think of replacing the implementation of
ScalaPresentationCompilerto useRawPresentationCompileras underlying impl and just call it in safe way.The implementation was tested on the actual LSP server and it works fine.