[VS] Get source text of an Entity symbol's signature for viewing metadata #11325
Conversation
…handling of determining if we should do semantic diagnostics for a given file.
|
This is ready. We will iterate more on improving the signature generation in separate PRs, but this is already much more useful than decompiling to C#. |
| @@ -1424,7 +1424,7 @@ module private TastDefinitionPrinting = | |||
|
|
|||
| let nameL = eventTag |> wordL | |||
| let typL = layoutType denv (e.GetDelegateType(amap, m)) | |||
| staticL ^^ WordL.keywordEvent ^^ nameL ^^ WordL.colon ^^ typL | |||
| staticL ^^ WordL.keywordMember ^^ nameL ^^ WordL.colon ^^ typL | |||
| @@ -125,14 +125,14 @@ type internal FSharpDocumentDiagnosticAnalyzer | |||
| |> RoslynHelpers.StartAsyncAsTask cancellationToken | |||
|
|
|||
| member this.AnalyzeSemanticsAsync(document: Document, cancellationToken: CancellationToken): Task<ImmutableArray<Diagnostic>> = | |||
| if document.Project.IsFSharpMiscellaneousOrMetadata && not document.IsFSharpScript then Task.FromResult(ImmutableArray.Empty) | |||
There was a problem hiding this comment.
Typically here we would move this into the computation expression and say
do! (not document.Project.IsFSharpMiscellaneousOrMetadata || document.IsFSharpScript)There was a problem hiding this comment.
asyncMaybe doesn't support a bind operation for just bool, though we could add it.
I would also find it confusing for it to be used in that way. A simple if/then is very clear comparatively.
asyncMaybe itself is a good abstraction so you don't have to constantly keep handling the None case, but that's all that it should do.
There was a problem hiding this comment.
It does, it's do! Option.guard expr where expr is a bool-returning thing. This is the canonical way that invariants are held in this layer of the tools. I'll submit a separate PR for this, since we should be consistent
| @@ -34,6 +34,9 @@ type internal SimplifyNameDiagnosticAnalyzer | |||
| interface IFSharpSimplifyNameDiagnosticAnalyzer with | |||
|
|
|||
| member _.AnalyzeSemanticsAsync(descriptor, document: Document, cancellationToken: CancellationToken) = | |||
| if document.Project.IsFSharpMiscellaneousOrMetadata && not document.IsFSharpScript then Tasks.Task.FromResult(ImmutableArray.Empty) | |||
There was a problem hiding this comment.
Typically here we would move this into the computation expression and say
do! (not document.Project.IsFSharpMiscellaneousOrMetadata || document.IsFSharpScript)There was a problem hiding this comment.
Whoops, this should be Option.guard (...)
| @@ -24,6 +24,9 @@ type internal UnusedDeclarationsAnalyzer | |||
| interface IFSharpUnusedDeclarationsDiagnosticAnalyzer with | |||
|
|
|||
| member _.AnalyzeSemanticsAsync(descriptor, document, cancellationToken) = | |||
| if document.Project.IsFSharpMiscellaneousOrMetadata && not document.IsFSharpScript then Threading.Tasks.Task.FromResult(ImmutableArray.Empty) | |||
There was a problem hiding this comment.
Typically here we would move this into the computation expression and say
do! (not document.Project.IsFSharpMiscellaneousOrMetadata || document.IsFSharpScript)| @@ -38,6 +38,9 @@ type internal UnusedOpensDiagnosticAnalyzer | |||
| interface IFSharpUnusedOpensDiagnosticAnalyzer with | |||
|
|
|||
| member _.AnalyzeSemanticsAsync(descriptor, document: Document, cancellationToken: CancellationToken) = | |||
| if document.Project.IsFSharpMiscellaneousOrMetadata && not document.IsFSharpScript then Tasks.Task.FromResult(ImmutableArray.Empty) | |||
There was a problem hiding this comment.
Typically here we would move this into the computation expression and say
do! (not document.Project.IsFSharpMiscellaneousOrMetadata || document.IsFSharpScript)| let! _, _, projectOptions = projectInfoManager.TryGetOptionsForDocumentOrProject (tmpShownDoc, cancellationToken, userOpName) | ||
| let! _, _, checkResults = checkerProvider.Checker.ParseAndCheckDocument(tmpShownDoc, projectOptions, userOpName) | ||
| let! r = | ||
| let rec areTypesEqual (ty1: FSharpType) (ty2: FSharpType) = |
There was a problem hiding this comment.
Agree with the commment below. We should file an issue to figure out a way to lift this into FCS proper.
There was a problem hiding this comment.
Equality does exist for symbols, but the symbols from the generated metadata may be malformed, or just not exactly match the requirements for the existing equality in FCS. Basically, we need NicePrint to generate signatures that have symbols that are equatable. I think we will get there, especially when we start tweaking it for generating better signatures of implementation files
| } | ||
|
|
||
| let span = | ||
| match Async.RunSynchronously(goToAsync, cancellationToken = cancellationToken) with |
There was a problem hiding this comment.
This has my ears raised a bit. Is there an awaitable thing we could potentially plug this into? Naiive question and I know that this whole thing runs async anyways, but I fear that something in VS will cause us to run in the UI thread and we'd introduce a UI freeze. I don't have anything concrete to test this with though, and so my concern there might be meaningless.
There was a problem hiding this comment.
TryGoToDefinition is not awaitable, even in Roslyn from last I checked. It must block, but while it's blocked it will show the animating status bar which is cancellable.
The calls made in the asyncMaybe block don't call into anything that requires the UI thread, it just calls FCS async functions and gets the source text from the document.
…data (dotnet#11325) * Initial work for generating a signature of a given symbol for viewing metadata * Do not output the 'event' keyword * Adding open paths and fixing surface area * Fixing tests. Adding more extensions to Project and Document. Better handling of determining if we should do semantic diagnostics for a given file. * Trying to go to definition on metadata. Managing metadata as source projects. * Navigating to external symbol * ignoring tests * Renaming TryGenerateSignatureText to TryGetMetadataText * Fixing namespace and some parts of module
Related to this: #11303
The PR from @baronfel : #11201 will probably be useful too.
At the moment, when trying to navigate to an external symbol, we decompile the DLL as C# code that the symbol exists in. This isn't particularly useful when you have a decompiled C# view of F# metadata; it isn't as helpful compared to what a F# signature view looks like.
What we really want to do is generate a signature (.fsi) file to be used as metadata viewing in VS for any symbol, C# or F#, as long as it was navigated from a F# document.