Skip to content
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

initial stab at completion context for string literals #830

Merged
merged 4 commits into from
Sep 9, 2021
Merged

initial stab at completion context for string literals #830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c5ac6d4
initial stab at completion context
baronfel Sep 8, 2021
00a658e
tweak context-aware completions
baronfel Sep 8, 2021
ec3b49e
also skip hover calculation as well
baronfel Sep 8, 2021
c4e5af8
revert accidental downgrade of global.json
baronfel Sep 9, 2021
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
197 changes: 105 additions & 92 deletions src/FsAutoComplete.Core/ParseAndCheckResults.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ open Utils
open FSharp.Compiler.Text
open FSharp.Compiler
open FsAutoComplete.Logging
open FsAutoComplete.UntypedAstUtils
open FSharp.UMX

[<RequireQualifiedAccess>]
Expand Down Expand Up @@ -233,38 +234,44 @@ type ParseAndCheckResults
| _ ->
Ok(tip)

member __.TryGetToolTipEnhanced (pos: Pos) (lineStr: LineStr) =
match Lexer.findLongIdents(pos.Column, lineStr) with
| None -> Error "Cannot find ident for tooltip"
| Some(col,identIsland) ->
let identIsland = Array.toList identIsland
// TODO: Display other tooltip types, for example for strings or comments where appropriate
let tip = checkResults.GetToolTipText(pos.Line, col, lineStr, identIsland, FSharpTokenTag.Identifier)
let symbol = checkResults.GetSymbolUseAtLocation(pos.Line, col, lineStr, identIsland)

match tip with
| FSharpToolTipText(elems) when elems |> List.forall ((=) FSharpToolTipElement.None) && symbol.IsNone ->
match identIsland with
| [ident] ->
match KeywordList.keywordTooltips.TryGetValue ident with
| true, tip ->
Ok (tip, ident, "", None)
| _ ->
member x.TryGetToolTipEnhanced (pos: Pos) (lineStr: LineStr) =
match x.GetParseResults.ParseTree with
| None -> Error "No parse tree"
| Some parsedInput ->
match Completion.atPos (pos, parsedInput) with
| Completion.Context.StringLiteral -> Ok None
| Completion.Context.Unknown ->
match Lexer.findLongIdents(pos.Column, lineStr) with
| None -> Error "Cannot find ident for tooltip"
| Some(col,identIsland) ->
let identIsland = Array.toList identIsland
// TODO: Display other tooltip types, for example for strings or comments where appropriate
let tip = checkResults.GetToolTipText(pos.Line, col, lineStr, identIsland, FSharpTokenTag.Identifier)
let symbol = checkResults.GetSymbolUseAtLocation(pos.Line, col, lineStr, identIsland)

match tip with
| FSharpToolTipText(elems) when elems |> List.forall ((=) FSharpToolTipElement.None) && symbol.IsNone ->
match identIsland with
| [ident] ->
match KeywordList.keywordTooltips.TryGetValue ident with
| true, tip ->
Ok (Some (tip, ident, "", None))
| _ ->
Error "No tooltip information"
| _ ->
Error "No tooltip information"
| _ ->
Error "No tooltip information"
| _ ->
match symbol with
| None ->
Error "No tooltip information"
| Some symbol ->
match symbol with
| None ->
Error "No tooltip information"
| Some symbol ->

match SignatureFormatter.getTooltipDetailsFromSymbolUse symbol with
| None ->
Error "No tooltip information"
| Some (signature, footer) ->
let typeDoc = getTypeIfConstructor symbol.Symbol |> Option.map (fun n -> n.XmlDocSig)
Ok (tip, signature, footer, typeDoc)
match SignatureFormatter.getTooltipDetailsFromSymbolUse symbol with
| None ->
Error "No tooltip information"
| Some (signature, footer) ->
let typeDoc = getTypeIfConstructor symbol.Symbol |> Option.map (fun n -> n.XmlDocSig)
Ok (Some (tip, signature, footer, typeDoc))

member __.TryGetFormattedDocumentation (pos: Pos) (lineStr: LineStr) =
match Lexer.findLongIdents(pos.Column - 1, lineStr) with
Expand Down Expand Up @@ -424,72 +431,78 @@ type ParseAndCheckResults
| None -> ResultOrString.Error "No symbol information found"
| Some hlp -> Ok hlp

member __.TryGetCompletions (pos: Pos) (lineStr: LineStr) filter (getAllSymbols : unit -> AssemblySymbol list) = async {
try
let longName = FSharp.Compiler.SourceCodeServices.QuickParse.GetPartialLongNameEx(lineStr, pos.Column - 1)
let residue = longName.PartialIdent
logger.info (Log.setMessage "TryGetCompletions - long name: {longName}" >> Log.addContextDestructured "longName" longName)

let getAllSymbols() =
getAllSymbols()
|> List.filter (fun entity -> entity.FullName.Contains "." && not (PrettyNaming.IsOperatorName entity.Symbol.DisplayName))

let token = Lexer.getSymbol pos.Line (pos.Column - 1) lineStr SymbolLookupKind.Simple [||]
logger.info (Log.setMessage "TryGetCompletions - token: {token}" >> Log.addContextDestructured "token" token)
let isEmpty = longName.QualifyingIdents.IsEmpty && String.IsNullOrWhiteSpace longName.PartialIdent && longName.LastDotPos.IsNone

match token with
| Some k when k.Kind = Other && not isEmpty -> return None
| Some k when k.Kind = Operator -> return None
| Some k when k.Kind = Keyword -> return None
| _ ->
member x.TryGetCompletions (pos: Pos) (lineStr: LineStr) filter (getAllSymbols : unit -> AssemblySymbol list) = async {
match x.GetParseResults.ParseTree with
| None -> return None
| Some parsedInput ->
match Completion.atPos (pos, parsedInput) with
| Completion.Context.StringLiteral -> return None
baronfel marked this conversation as resolved.
Show resolved Hide resolved
| Completion.Context.Unknown ->
try
let longName = FSharp.Compiler.SourceCodeServices.QuickParse.GetPartialLongNameEx(lineStr, pos.Column - 1)
let residue = longName.PartialIdent
logger.info (Log.setMessage "TryGetCompletions - long name: {longName}" >> Log.addContextDestructured "longName" longName)

let getAllSymbols() =
getAllSymbols()
|> List.filter (fun entity -> entity.FullName.Contains "." && not (PrettyNaming.IsOperatorName entity.Symbol.DisplayName))

let token = Lexer.getSymbol pos.Line (pos.Column - 1) lineStr SymbolLookupKind.Simple [||]
logger.info (Log.setMessage "TryGetCompletions - token: {token}" >> Log.addContextDestructured "token" token)
let isEmpty = longName.QualifyingIdents.IsEmpty && String.IsNullOrWhiteSpace longName.PartialIdent && longName.LastDotPos.IsNone

match token with
| Some k when k.Kind = Other && not isEmpty -> return None
| Some k when k.Kind = Operator -> return None
| Some k when k.Kind = Keyword -> return None
| _ ->

let results = checkResults.GetDeclarationListInfo(Some parseResults, pos.Line, lineStr, longName, getAllSymbols)

let getKindPriority = function
| FSharpCompletionItemKind.CustomOperation -> -1
| FSharpCompletionItemKind.Property -> 0
| FSharpCompletionItemKind.Field -> 1
| FSharpCompletionItemKind.Method (isExtension = false) -> 2
| FSharpCompletionItemKind.Event -> 3
| FSharpCompletionItemKind.Argument -> 4
| FSharpCompletionItemKind.Other -> 5
| FSharpCompletionItemKind.Method (isExtension = true) -> 6

let decls =
match filter with
| Some "StartsWith" ->
results.Items
|> Array.filter (fun d -> d.Name.StartsWith(residue, StringComparison.InvariantCultureIgnoreCase))
| Some "Contains" ->
results.Items
|> Array.filter (fun d -> d.Name.IndexOf(residue, StringComparison.InvariantCultureIgnoreCase) >= 0)
| _ -> results.Items

let sortedDecls =
decls
|> Array.sortWith (fun x y ->
let transformKind (item: FSharpDeclarationListItem) =
if item.Kind = FSharpCompletionItemKind.Field && item.Glyph = FSharpGlyph.Method then
FSharpCompletionItemKind.Method false
elif item.Kind = FSharpCompletionItemKind.Argument && item.Glyph = FSharpGlyph.Property then
FSharpCompletionItemKind.Property
else
item.Kind

let mutable n = (not x.IsResolved).CompareTo(not y.IsResolved)
if n <> 0 then n else
n <- (getKindPriority <| transformKind x).CompareTo(getKindPriority <| transformKind y)
let results = checkResults.GetDeclarationListInfo(Some parseResults, pos.Line, lineStr, longName, getAllSymbols)

let getKindPriority = function
| FSharpCompletionItemKind.CustomOperation -> -1
| FSharpCompletionItemKind.Property -> 0
| FSharpCompletionItemKind.Field -> 1
| FSharpCompletionItemKind.Method (isExtension = false) -> 2
| FSharpCompletionItemKind.Event -> 3
| FSharpCompletionItemKind.Argument -> 4
| FSharpCompletionItemKind.Other -> 5
| FSharpCompletionItemKind.Method (isExtension = true) -> 6

let decls =
match filter with
| Some "StartsWith" ->
results.Items
|> Array.filter (fun d -> d.Name.StartsWith(residue, StringComparison.InvariantCultureIgnoreCase))
| Some "Contains" ->
results.Items
|> Array.filter (fun d -> d.Name.IndexOf(residue, StringComparison.InvariantCultureIgnoreCase) >= 0)
| _ -> results.Items

let sortedDecls =
decls
|> Array.sortWith (fun x y ->
let transformKind (item: FSharpDeclarationListItem) =
if item.Kind = FSharpCompletionItemKind.Field && item.Glyph = FSharpGlyph.Method then
FSharpCompletionItemKind.Method false
elif item.Kind = FSharpCompletionItemKind.Argument && item.Glyph = FSharpGlyph.Property then
FSharpCompletionItemKind.Property
else
item.Kind

let mutable n = (not x.IsResolved).CompareTo(not y.IsResolved)
if n <> 0 then n else
n <- (not x.IsOwnMember).CompareTo(not y.IsOwnMember)
n <- (getKindPriority <| transformKind x).CompareTo(getKindPriority <| transformKind y)
if n <> 0 then n else
n <- StringComparer.OrdinalIgnoreCase.Compare(x.Name, y.Name)
n <- (not x.IsOwnMember).CompareTo(not y.IsOwnMember)
if n <> 0 then n else
x.MinorPriority.CompareTo(y.MinorPriority))
n <- StringComparer.OrdinalIgnoreCase.Compare(x.Name, y.Name)
if n <> 0 then n else
x.MinorPriority.CompareTo(y.MinorPriority))

let shouldKeywords = sortedDecls.Length > 0 && not results.IsForType && not results.IsError && List.isEmpty longName.QualifyingIdents
return Some (sortedDecls, residue, shouldKeywords)
with :? TimeoutException -> return None
let shouldKeywords = sortedDecls.Length > 0 && not results.IsForType && not results.IsError && List.isEmpty longName.QualifyingIdents
return Some (sortedDecls, residue, shouldKeywords)
with :? TimeoutException -> return None
}

member __.GetAllEntities (publicOnly: bool) : AssemblySymbol list =
Expand Down Expand Up @@ -526,6 +539,6 @@ type ParseAndCheckResults


member __.GetAST = parseResults.ParseTree
member __.GetCheckResults = checkResults
member __.GetParseResults = parseResults
member __.GetCheckResults: FSharpCheckFileResults = checkResults
member __.GetParseResults: FSharpParseFileResults = parseResults
member __.FileName: string<LocalPath> = UMX.tag parseResults.FileName
30 changes: 30 additions & 0 deletions src/FsAutoComplete.Core/UntypedAstUtils.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1882,3 +1882,33 @@ module Printf =
| _ -> ()
//debug "%A" idents
result.ToArray()

module Completion =

[<RequireQualifiedAccess>]
type Context =
| StringLiteral
| Unknown

let atPos (pos: Pos, ast: ParsedInput): Context =
let visitor =
{ new SourceCodeServices.AstTraversal.AstVisitorBase<Context>() with

member x.VisitExpr(path, traverseExpr, defaultTraverse, expr): Context option =
if Range.rangeContainsPos expr.Range pos
then
match expr with
baronfel marked this conversation as resolved.
Show resolved Hide resolved
| SynExpr.Const(SynConst.String _, _) -> Some Context.StringLiteral
| SynExpr.InterpolatedString (parts, _) ->
parts
|> List.tryPick (
function | SynInterpolatedStringPart.String(s, m) when Range.rangeContainsPos m pos -> Some Context.StringLiteral
| SynInterpolatedStringPart.String _ -> None
| SynInterpolatedStringPart.FillExpr(e, _) when Range.rangeContainsPos e.Range pos -> defaultTraverse e // gotta dive into the expr to see if we're in a literal inside the expr
| SynInterpolatedStringPart.FillExpr _ -> None
)
| _ -> defaultTraverse expr
else None
}
FSharp.Compiler.SourceCodeServices.AstTraversal.Traverse(pos, ast, visitor)
|> Option.defaultValue Context.Unknown
6 changes: 4 additions & 2 deletions src/FsAutoComplete/FsAutoComplete.Lsp.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ type FSharpLspServer(backgroundServiceEnabled: bool, state: State, lspClient: FS
return! success (Some completionList)
| _ ->
logger.info (Log.setMessage "TextDocumentCompletion - no completion results")
return! success (Some { IsIncomplete = true; Items = [||] })
return! success (Some { IsIncomplete = false; Items = [||] })
baronfel marked this conversation as resolved.
Show resolved Hide resolved
}

override __.CompletionItemResolve(ci: CompletionItem) = async {
Expand Down Expand Up @@ -950,7 +950,9 @@ type FSharpLspServer(backgroundServiceEnabled: bool, state: State, lspClient: FS
| CoreResponse.InfoRes msg | CoreResponse.ErrorRes msg ->
LspResult.internalError msg
|> async.Return
| CoreResponse.Res(tip, signature, footer, typeDoc) ->
| CoreResponse.Res None ->
async.Return (success None)
| CoreResponse.Res(Some(tip, signature, footer, typeDoc)) ->
let formatCommentStyle =
if config.TooltipMode = "full" then
TipFormatter.FormatCommentStyle.FullEnhanced
Expand Down