Skip to content

Colorize F# signature help #2034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 17, 2016
Merged

Colorize F# signature help #2034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4e5f1e
Colorize F# signature help
dungpa Dec 17, 2016
61faeff
Remove unnecessary symbol API
dungpa Dec 17, 2016
5c8041a
Fix assembly references
dungpa Dec 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions vsintegration/src/FSharp.Editor/CommonConstants.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@ module internal FSharpCommonConstants =
[<Literal>]
let FSharpContentTypeName = "F#"
[<Literal>]
let FSharpSignatureHelpContentTypeName = "F# Signature Help"
[<Literal>]
let FSharpLanguageServiceCallbackName = "F# Language Service"
60 changes: 52 additions & 8 deletions vsintegration/src/FSharp.Editor/Completion/SignatureHelp.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Microsoft.VisualStudio.FSharp.Editor

open System
open System.Text.RegularExpressions
open System.Composition
open System.Collections.Concurrent
open System.Collections.Generic
Expand Down Expand Up @@ -181,20 +182,49 @@ type internal FSharpSignatureHelpProvider
let paramDoc = XmlDocumentation.BuildMethodParamText(documentationBuilder, method.XmlDoc, p.ParameterName)
let doc = if String.IsNullOrWhiteSpace(paramDoc) then [||]
else [| TaggedText(TextTags.Text, paramDoc) |]
yield (p.ParameterName,p.IsOptional,doc,[| TaggedText(TextTags.Text,p.Display) |]) |]
let parameterParts =
if isStaticArgTip then
[| TaggedText(TextTags.Class, p.Display) |]
else
let str = p.Display
match str.IndexOf(':') with
| -1 -> [| TaggedText(TextTags.Parameter, str) |]
| 0 ->
[| TaggedText(TextTags.Punctuation, ":");
TaggedText(TextTags.Class, str.[1..]) |]
| i ->
[| TaggedText(TextTags.Parameter, str.[..i-1]);
TaggedText(TextTags.Punctuation, ":");
TaggedText(TextTags.Class, str.[i+1..]) |]
yield (p.ParameterName, p.IsOptional, doc, parameterParts)
|]

let hasParamComments (pcs: (string*bool*TaggedText[]*TaggedText[])[]) =
pcs |> Array.exists (fun (_, _, doc, _) -> doc.Length > 0)

let summaryText = if String.IsNullOrWhiteSpace(summaryDoc) then [| TaggedText() |]
elif (hasParamComments parameters) then [| TaggedText(TextTags.Text, summaryDoc + "\n") |]
else [| TaggedText(TextTags.Text, summaryDoc) |]

let summaryText =
let doc =
if String.IsNullOrWhiteSpace summaryDoc then
String.Empty
elif hasParamComments parameters then
summaryDoc + "\n"
else
summaryDoc
[| TaggedText(TextTags.Text, doc) |]

// Prepare the text to display
let descriptionParts = [| TaggedText(TextTags.Text, method.TypeText) |]
let prefixParts = [| TaggedText(TextTags.Text, methodGroup.MethodName); TaggedText(TextTags.Punctuation, (if isStaticArgTip then "<" else "(")) |]
let descriptionParts =
let str = method.TypeText
if str.StartsWith(":", StringComparison.OrdinalIgnoreCase) then
[| TaggedText(TextTags.Punctuation, ":");
TaggedText(TextTags.Class, str.[1..]) |]
else
[| TaggedText(TextTags.Text, str) |]
let prefixParts =
[| TaggedText(TextTags.Method, methodGroup.MethodName);
TaggedText(TextTags.Punctuation, (if isStaticArgTip then "<" else "(")) |]
let separatorParts = [| TaggedText(TextTags.Punctuation, ", ") |]
let suffixParts = [| TaggedText(TextTags.Text, (if isStaticArgTip then ">" else ")")) |]
let suffixParts = [| TaggedText(TextTags.Punctuation, (if isStaticArgTip then ">" else ")")) |]

let completionItem = (method.HasParamArrayArg, summaryText, prefixParts, separatorParts, suffixParts, parameters, descriptionParts)
// FSROSLYNTODO: Do we need a cache like for completion?
Expand Down Expand Up @@ -244,3 +274,17 @@ type internal FSharpSignatureHelpProvider
return null
} |> CommonRoslynHelpers.StartAsyncAsTask cancellationToken

open System.ComponentModel.Composition
open Microsoft.VisualStudio.Utilities
open Microsoft.VisualStudio.Text
open Microsoft.VisualStudio.Text.Classification
open Microsoft.CodeAnalysis.Editor.Implementation.IntelliSense.SignatureHelp.Presentation

// Enable colorized signature help for F# buffers

[<Export(typeof<IClassifierProvider>)>]
[<ContentType(FSharpCommonConstants.FSharpSignatureHelpContentTypeName)>]
type FSharpSignatureHelpClassifierProvider [<ImportingConstructor>] (typeMap) =
interface IClassifierProvider with
override __.GetClassifier (buffer: ITextBuffer) =
buffer.Properties.GetOrCreateSingletonProperty(fun _ -> SignatureHelpClassifier(buffer, typeMap) :> _)
5 changes: 5 additions & 0 deletions vsintegration/src/FSharp.Editor/ContentType.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ module FSharpStaticTypeDefinitions =
[<BaseDefinition(ContentTypeNames.RoslynContentType)>]
let FSharpContentTypeDefinition = ContentTypeDefinition()

[<Export>]
[<Name(FSharpCommonConstants.FSharpSignatureHelpContentTypeName)>]
[<BaseDefinition("sighelp")>]
let FSharpSignatureHelpContentTypeDefinition = ContentTypeDefinition()

[<ExportContentTypeLanguageService(FSharpCommonConstants.FSharpContentTypeName, FSharpCommonConstants.FSharpLanguageName)>]
type FSharpContentType [<System.Composition.ImportingConstructor>](contentTypeRegistry : IContentTypeRegistryService) =
member this.contentTypeRegistryService = contentTypeRegistry
Expand Down
3 changes: 3 additions & 0 deletions vsintegration/tests/unittests/VisualFSharp.Unittests.fsproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,9 @@
<Reference Include="Microsoft.VisualStudio.Shell.Interop.10.0.dll" />
<Reference Include="Microsoft.VisualStudio.Shell.Interop.11.0.dll" />
<Reference Include="Microsoft.VisualStudio.Shell.Interop.dll" />
<Reference Include="Microsoft.VisualStudio.Text.Logic, Version=$(RoslynVSBinariesVersion).0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
<HintPath>$(FSharpSourcesRoot)\..\packages\Microsoft.VisualStudio.Text.Logic.$(RoslynVSPackagesVersion)\lib\net45\Microsoft.VisualStudio.Text.Logic.dll</HintPath>
</Reference>
<Reference Include="Microsoft.VisualStudio.Threading, Version=$(RoslynVSBinariesVersion).0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
<HintPath>$(FSharpSourcesRoot)\..\packages\Microsoft.VisualStudio.Threading.14.1.131\lib\net45\Microsoft.VisualStudio.Threading.dll</HintPath>
<Private>True</Private>
Expand Down