Skip to content

Include settable properties in attribute completions #14697

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 6 commits into from
Feb 10, 2023
Merged

Include settable properties in attribute completions #14697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
886f027
Include settable properties in attribute completions
kerams Feb 5, 2023
db90fa9
Update surface area
kerams Feb 5, 2023
29d36b9
Fix some tests, remove CompletionContext.AttributeApplicationParamete…
kerams Feb 6, 2023
5a78473
Move fishy test
kerams Feb 6, 2023
439321b
Fix formatting
kerams Feb 6, 2023
5912f17
Merge branch 'main' into att
abonie Feb 9, 2023
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: 1 addition & 1 deletion src/Compiler/Service/FSharpCheckerResults.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1262,7 +1262,7 @@ type internal TypeCheckInfo
// No completion at '...: string'
| Some (CompletionContext.RecordField (RecordContext.Declaration true)) -> None

// Completion at ' SomeMethod( ... ) ' with named arguments
// Completion at ' SomeMethod( ... ) ' or ' [<SomeAttribute( ... )>] ' with named arguments
| Some (CompletionContext.ParameterList (endPos, fields)) ->
let results = GetNamedParametersAndSettableFields endPos

Expand Down
138 changes: 100 additions & 38 deletions src/Compiler/Service/ServiceParseTreeWalk.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,12 @@ type SyntaxVisitorBase<'T>() =
ignore path
defaultTraverse synType

abstract VisitAttributeApplication: path: SyntaxVisitorPath * attributes: SynAttributeList -> 'T option

default _.VisitAttributeApplication(path, attributes) =
ignore (path, attributes)
None

/// A range of utility functions to assist with traversing an AST
module SyntaxTraversal =

Expand Down Expand Up @@ -278,9 +284,10 @@ module SyntaxTraversal =

match m with
| SynModuleDecl.ModuleAbbrev (_ident, _longIdent, _range) -> None
| SynModuleDecl.NestedModule (decls = synModuleDecls) ->
| SynModuleDecl.NestedModule (decls = synModuleDecls; moduleInfo = SynComponentInfo (attributes = attributes)) ->
synModuleDecls
|> List.map (fun x -> dive x x.Range (traverseSynModuleDecl path))
|> List.append (attributeApplicationDives path attributes)
|> pick decl
| SynModuleDecl.Let (isRecursive, synBindingList, range) ->
match visitor.VisitLetOrUse(path, isRecursive, traverseSynBinding path, synBindingList, range) with
Expand All @@ -296,7 +303,7 @@ module SyntaxTraversal =
|> pick decl
| SynModuleDecl.Exception (_synExceptionDefn, _range) -> None
| SynModuleDecl.Open (_target, _range) -> None
| SynModuleDecl.Attributes (_synAttributes, _range) -> None
| SynModuleDecl.Attributes (attributes, _) -> attributeApplicationDives path attributes |> pick decl
| SynModuleDecl.HashDirective (parsedHashDirective, range) -> visitor.VisitHashDirective(path, parsedHashDirective, range)
| SynModuleDecl.NamespaceFragment (synModuleOrNamespace) -> traverseSynModuleOrNamespace path synModuleOrNamespace

Expand Down Expand Up @@ -549,7 +556,7 @@ module SyntaxTraversal =
| SynExpr.Lambda (args = synSimplePats; body = synExpr) ->
match synSimplePats with
| SynSimplePats.SimplePats (pats, _) ->
match visitor.VisitSimplePats(path, pats) with
match traverseSynSimplePats path pats with
| None -> traverseSynExpr synExpr
| x -> x
| _ -> traverseSynExpr synExpr
Expand Down Expand Up @@ -792,7 +799,10 @@ module SyntaxTraversal =
| SynPat.Ands (ps, _)
| SynPat.Tuple (_, ps, _)
| SynPat.ArrayOrList (_, ps, _) -> ps |> List.tryPick (traversePat path)
| SynPat.Attrib (p, _, _) -> traversePat path p
| SynPat.Attrib (p, attributes, m) ->
match traversePat path p with
| None -> attributeApplicationDives path attributes |> pick m attributes
| x -> x
| SynPat.LongIdent (argPats = args) ->
match args with
| SynArgPats.Pats ps -> ps |> List.tryPick (traversePat path)
Expand All @@ -805,6 +815,17 @@ module SyntaxTraversal =

visitor.VisitPat(origPath, defaultTraverse, pat)

and traverseSynSimplePats origPath (pats: SynSimplePat list) =
match visitor.VisitSimplePats(origPath, pats) with
| None ->
pats
|> List.tryPick (fun pat ->
match pat with
| SynSimplePat.Attrib (attributes = attributes; range = m) ->
attributeApplicationDives origPath attributes |> pick m attributes
| _ -> None)
| x -> x

and traverseSynType origPath (StripParenTypes ty) =
let defaultTraverse ty =
let path = SyntaxNode.SynType ty :: origPath
Expand Down Expand Up @@ -854,36 +875,64 @@ module SyntaxTraversal =
match visitor.VisitComponentInfo(origPath, synComponentInfo) with
| Some x -> Some x
| None ->
[
match synTypeDefnRepr with
| SynTypeDefnRepr.Exception _ ->
// This node is generated in CheckExpressions.fs, not in the AST.
// But note exception declarations are missing from this tree walk.
()
| SynTypeDefnRepr.ObjectModel (synTypeDefnKind, synMemberDefns, _oRange) ->
// traverse inherit function is used to capture type specific data required for processing Inherit part
let traverseInherit (synType: SynType, range: range) =
visitor.VisitInheritSynMemberDefn(path, synComponentInfo, synTypeDefnKind, synType, synMemberDefns, range)
match synComponentInfo with
| SynComponentInfo (attributes = attributes) ->
[
yield! attributeApplicationDives path attributes

match synTypeDefnRepr with
| SynTypeDefnRepr.Exception _ ->
// This node is generated in CheckExpressions.fs, not in the AST.
// But note exception declarations are missing from this tree walk.
()
| SynTypeDefnRepr.ObjectModel (synTypeDefnKind, synMemberDefns, _oRange) ->
// traverse inherit function is used to capture type specific data required for processing Inherit part
let traverseInherit (synType: SynType, range: range) =
visitor.VisitInheritSynMemberDefn(path, synComponentInfo, synTypeDefnKind, synType, synMemberDefns, range)

yield!
synMemberDefns
|> normalizeMembersToDealWithPeculiaritiesOfGettersAndSetters path traverseInherit
| SynTypeDefnRepr.Simple (synTypeDefnSimpleRepr, _range) ->
match synTypeDefnSimpleRepr with
| SynTypeDefnSimpleRepr.Record (_synAccessOption, fields, m) ->
yield dive () synTypeDefnRepr.Range (fun () -> traverseRecordDefn path fields m)
| SynTypeDefnSimpleRepr.Union (_synAccessOption, cases, m) ->
yield dive () synTypeDefnRepr.Range (fun () -> traverseUnionDefn path cases m)
| SynTypeDefnSimpleRepr.Enum (cases, m) ->
yield dive () synTypeDefnRepr.Range (fun () -> traverseEnumDefn path cases m)
| SynTypeDefnSimpleRepr.TypeAbbrev (_, synType, m) ->
yield dive synTypeDefnRepr synTypeDefnRepr.Range (fun _ -> visitor.VisitTypeAbbrev(path, synType, m))
| _ -> ()
yield!
synMemberDefns
|> normalizeMembersToDealWithPeculiaritiesOfGettersAndSetters path traverseInherit
| SynTypeDefnRepr.Simple (synTypeDefnSimpleRepr, _range) ->
match synTypeDefnSimpleRepr with
| SynTypeDefnSimpleRepr.Record (_synAccessOption, fields, m) ->
yield dive () synTypeDefnRepr.Range (fun () -> visitor.VisitRecordDefn(path, fields, m))
| SynTypeDefnSimpleRepr.Union (_synAccessOption, cases, m) ->
yield dive () synTypeDefnRepr.Range (fun () -> visitor.VisitUnionDefn(path, cases, m))
| SynTypeDefnSimpleRepr.Enum (cases, m) ->
yield dive () synTypeDefnRepr.Range (fun () -> visitor.VisitEnumDefn(path, cases, m))
| SynTypeDefnSimpleRepr.TypeAbbrev (_, synType, m) ->
yield dive synTypeDefnRepr synTypeDefnRepr.Range (fun _ -> visitor.VisitTypeAbbrev(path, synType, m))
| _ -> ()
yield!
synMemberDefns
|> normalizeMembersToDealWithPeculiaritiesOfGettersAndSetters path (fun _ -> None)
]
|> pick tRange tydef
|> normalizeMembersToDealWithPeculiaritiesOfGettersAndSetters path (fun _ -> None)
]
|> pick tRange tydef

and traverseRecordDefn path fields m =
fields
|> List.tryPick (fun (SynField (attributes = attributes)) -> attributeApplicationDives path attributes |> pick m attributes)
|> Option.orElseWith (fun () -> visitor.VisitRecordDefn(path, fields, m))

and traverseEnumDefn path cases m =
cases
|> List.tryPick (fun (SynEnumCase (attributes = attributes)) -> attributeApplicationDives path attributes |> pick m attributes)
|> Option.orElseWith (fun () -> visitor.VisitEnumDefn(path, cases, m))

and traverseUnionDefn path cases m =
cases
|> List.tryPick (fun (SynUnionCase (attributes = attributes; caseType = caseType)) ->
match attributeApplicationDives path attributes |> pick m attributes with
| None ->
match caseType with
| SynUnionCaseKind.Fields fields ->
fields
|> List.tryPick (fun (SynField (attributes = attributes)) ->
attributeApplicationDives path attributes |> pick m attributes)
| _ -> None
| x -> x)
|> Option.orElseWith (fun () -> visitor.VisitUnionDefn(path, cases, m))

and traverseSynMemberDefn path traverseInherit (m: SynMemberDefn) =
let pick (debugObj: obj) = pick m.Range debugObj
Expand All @@ -903,7 +952,7 @@ module SyntaxTraversal =

| SynMemberDefn.ImplicitCtor (ctorArgs = simplePats) ->
match simplePats with
| SynSimplePats.SimplePats (simplePats, _) -> visitor.VisitSimplePats(path, simplePats)
| SynSimplePats.SimplePats (simplePats, _) -> traverseSynSimplePats path simplePats
| _ -> None
| SynMemberDefn.ImplicitInherit (synType, synExpr, _identOption, range) ->
[
Expand All @@ -914,15 +963,21 @@ module SyntaxTraversal =
dive () synExpr.Range (fun () -> visitor.VisitImplicitInherit(path, traverseSynExpr path, synType, synExpr, range))
]
|> pick m
| SynMemberDefn.AutoProperty (synExpr = synExpr) -> traverseSynExpr path synExpr
| SynMemberDefn.AutoProperty (synExpr = synExpr; attributes = attributes) ->
match traverseSynExpr path synExpr with
| None -> attributeApplicationDives path attributes |> pick attributes
| x -> x
| SynMemberDefn.LetBindings (synBindingList, isRecursive, _, range) ->
match visitor.VisitLetOrUse(path, isRecursive, traverseSynBinding path, synBindingList, range) with
| None ->
synBindingList
|> List.map (fun x -> dive x x.RangeOfBindingWithRhs (traverseSynBinding path))
|> pick m
| x -> x
| SynMemberDefn.AbstractSlot(slotSig = SynValSig (synType = synType)) -> traverseSynType path synType
| SynMemberDefn.AbstractSlot(slotSig = SynValSig (synType = synType; attributes = attributes)) ->
match traverseSynType path synType with
| None -> attributeApplicationDives path attributes |> pick attributes
| x -> x
| SynMemberDefn.Interface (interfaceType = synType; members = synMemberDefnsOption) ->
match visitor.VisitInterfaceSynMemberDefnType(path, synType) with
| None ->
Expand Down Expand Up @@ -963,13 +1018,20 @@ module SyntaxTraversal =
let path = SyntaxNode.SynBinding b :: origPath

match b with
| SynBinding (headPat = synPat; expr = synExpr) ->
match traversePat path synPat with
| None -> traverseSynExpr path synExpr
| x -> x
| SynBinding (headPat = synPat; expr = synExpr; attributes = attributes; range = m) ->
[
yield! attributeApplicationDives path attributes
dive synPat synPat.Range (traversePat path)
dive synExpr synExpr.Range (traverseSynExpr path)
]
|> pick m b

visitor.VisitBinding(origPath, defaultTraverse, b)

and attributeApplicationDives origPath attributes =
attributes
|> List.map (fun attributes -> dive () attributes.Range (fun () -> visitor.VisitAttributeApplication(origPath, attributes)))

match parseTree with
| ParsedInput.ImplFile file ->
let l = file.Contents
Expand Down
3 changes: 3 additions & 0 deletions src/Compiler/Service/ServiceParseTreeWalk.fsi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,9 @@ type SyntaxVisitorBase<'T> =
abstract VisitTypeAbbrev: path: SyntaxVisitorPath * synType: SynType * range: range -> 'T option
default VisitTypeAbbrev: path: SyntaxVisitorPath * synType: SynType * range: range -> 'T option

abstract VisitAttributeApplication: path: SyntaxVisitorPath * attributes: SynAttributeList -> 'T option
default VisitAttributeApplication: path: SyntaxVisitorPath * attributes: SynAttributeList -> 'T option

module public SyntaxTraversal =

val internal rangeContainsPosLeftEdgeInclusive: m1: range -> p: pos -> bool
Expand Down
Loading