Skip to content

Symbols: add more APIs #13824

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 13 commits into from
Nov 7, 2022
Merged

Symbols: add more APIs #13824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7ed6a65
Symbols: add BasicQualifiedName, FSharpType.StrippedType
auduchinok Sep 1, 2022
61971c9
Add FSharpEntity.AsType
auduchinok Sep 1, 2022
7b68564
Add Mfv.IsRefCell
auduchinok Sep 1, 2022
30ad1f7
Remove duplicate Mfv.IsFunction definition
auduchinok Sep 1, 2022
db119fd
Update define
auduchinok Sep 1, 2022
b44bbc3
Reduce diff
auduchinok Sep 1, 2022
e0b96b7
Cleanup
auduchinok Sep 1, 2022
151da91
Merge branch 'main' into symbols-basicQualifiedName
vzarytovskii Sep 7, 2022
233c7ec
Update surface
auduchinok Sep 12, 2022
880a0c3
Merge branch 'main' into symbols-basicQualifiedName
T-Gro Oct 21, 2022
2376c1e
Update src/Compiler/Symbols/Symbols.fs
dsyme Oct 27, 2022
6223c88
Update src/Compiler/Symbols/Symbols.fsi
dsyme Oct 27, 2022
d62433c
renaming StrippedType to ErasedType
T-Gro Nov 3, 2022
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
51 changes: 42 additions & 9 deletions src/Compiler/Symbols/Symbols.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,18 +433,27 @@ type FSharpEntity(cenv: SymbolEnv, entity: EntityRef) =
Some (buildAccessPath (Some cp))
| Some _ -> None

member x.QualifiedName =
member x.CompiledRepresentation =
checkIsResolved()
let fail() = invalidOp (sprintf "the type '%s' does not have a qualified name" x.LogicalName)

let fail () =
invalidOp $"the type '{x.LogicalName}' does not have a qualified name"

#if !NO_TYPEPROVIDERS
if entity.IsTypeAbbrev || entity.IsProvidedErasedTycon || entity.IsNamespace then fail()
#else
if entity.IsTypeAbbrev || entity.IsNamespace then fail()
if entity.IsTypeAbbrev || entity.IsProvidedErasedTycon || entity.IsNamespace then fail ()
#else
if entity.IsTypeAbbrev || entity.IsNamespace then fail ()
#endif
match entity.CompiledRepresentation with
| CompiledTypeRepr.ILAsmNamed(tref, _, _) -> tref.QualifiedName
| CompiledTypeRepr.ILAsmOpen _ -> fail()

match entity.CompiledRepresentation with
| CompiledTypeRepr.ILAsmNamed(tref, _, _) -> tref
| CompiledTypeRepr.ILAsmOpen _ -> fail ()

member x.QualifiedName =
x.CompiledRepresentation.QualifiedName

member x.BasicQualifiedName =
x.CompiledRepresentation.BasicQualifiedName

member x.FullName =
checkIsResolved()
match x.TryFullName with
Expand Down Expand Up @@ -746,6 +755,10 @@ type FSharpEntity(cenv: SymbolEnv, entity: EntityRef) =
| None -> invalidOp "not a type abbreviation"
| Some ty -> FSharpType(cenv, ty)

member _.AsType() =
let ty = generalizedTyconRef cenv.g entity
FSharpType(cenv, ty)

override _.Attributes =
if isUnresolved() then makeReadOnlyCollection [] else
GetAttribInfosOfEntity cenv.g cenv.amap range0 entity
Expand Down Expand Up @@ -2250,6 +2263,11 @@ type FSharpMemberOrFunctionOrValue(cenv, d:FSharpMemberOrValData, item) =
| V vref -> isForallFunctionTy cenv.g vref.Type
| _ -> false

member x.IsRefCell =
match d with
| V vref -> not vref.IsCtorThisVal && isRefCellTy cenv.g vref.Type
| _ -> false

override x.Equals(other: obj) =
box x === other ||
match other with
Expand Down Expand Up @@ -2483,6 +2501,21 @@ type FSharpType(cenv, ty:TType) =
GetSuperTypeOfType cenv.g cenv.amap range0 ty
|> Option.map (fun ty -> FSharpType(cenv, ty))

member x.ErasedType=
FSharpType(cenv, stripTyEqnsWrtErasure EraseAll cenv.g ty)

member x.BasicQualifiedName =
let fail () =
invalidOp $"the type '{x}' does not have a qualified name"

protect <| fun () ->
match stripTyparEqns ty with
| TType_app(tcref, _, _) ->
match tcref.CompiledRepresentation with
| CompiledTypeRepr.ILAsmNamed(tref, _, _) -> tref.BasicQualifiedName
| CompiledTypeRepr.ILAsmOpen _ -> fail ()
| _ -> fail ()

member _.Instantiate(instantiation:(FSharpGenericParameter * FSharpType) list) =
let resTy = instType (instantiation |> List.map (fun (tyv, ty) -> tyv.TypeParameter, ty.Type)) ty
FSharpType(cenv, resTy)
Expand Down
16 changes: 14 additions & 2 deletions src/Compiler/Symbols/Symbols.fsi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,9 @@ type FSharpEntity =
/// Get the fully qualified name of the type or module
member QualifiedName: string

/// The fully qualified name of the type or module without strong assembly name.
member BasicQualifiedName: string

/// Get the full name of the type or module
member FullName: string

Expand Down Expand Up @@ -346,6 +349,9 @@ type FSharpEntity =
/// Get the type abbreviated by an F# type abbreviation
member AbbreviatedType: FSharpType

/// Instantiates FSharpType
member AsType: unit -> FSharpType

/// Get the cases of a union type
member UnionCases: IList<FSharpUnionCase>

Expand Down Expand Up @@ -933,8 +939,8 @@ type FSharpMemberOrFunctionOrValue =
/// Indicated if this is a value compiled to a method
member IsValCompiledAsMethod: bool

/// Indicates if this is a function
member IsFunction: bool
/// Indicates if this is a ref cell
member IsRefCell: bool

/// Indicated if this is a value
member IsValue: bool
Expand Down Expand Up @@ -1108,6 +1114,12 @@ type FSharpType =
/// if it is an instantiation of a generic type.
member BaseType: FSharpType option

/// Canonical form of the type with abbreviations, measures, and F# tuples and functions erased.
member ErasedType: FSharpType

/// The fully qualified name of the type or module without strong assembly name.
member BasicQualifiedName: string

/// Adjust the type by removing any occurrences of type inference variables, replacing them
/// systematically with lower-case type inference variables such as <c>'a</c>.
static member Prettify: ty: FSharpType -> FSharpType
Expand Down
9 changes: 9 additions & 0 deletions tests/FSharp.Compiler.Service.Tests/FSharp.CompilerService.SurfaceArea.netstandard.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4506,6 +4506,7 @@ FSharp.Compiler.Symbols.FSharpEntity: FSharp.Compiler.Symbols.FSharpAccessibilit
FSharp.Compiler.Symbols.FSharpEntity: FSharp.Compiler.Symbols.FSharpDelegateSignature FSharpDelegateSignature
FSharp.Compiler.Symbols.FSharpEntity: FSharp.Compiler.Symbols.FSharpDelegateSignature get_FSharpDelegateSignature()
FSharp.Compiler.Symbols.FSharpEntity: FSharp.Compiler.Symbols.FSharpType AbbreviatedType
FSharp.Compiler.Symbols.FSharpEntity: FSharp.Compiler.Symbols.FSharpType AsType()
FSharp.Compiler.Symbols.FSharpEntity: FSharp.Compiler.Symbols.FSharpType get_AbbreviatedType()
FSharp.Compiler.Symbols.FSharpEntity: FSharp.Compiler.Symbols.FSharpXmlDoc XmlDoc
FSharp.Compiler.Symbols.FSharpEntity: FSharp.Compiler.Symbols.FSharpXmlDoc get_XmlDoc()
Expand Down Expand Up @@ -4551,6 +4552,7 @@ FSharp.Compiler.Symbols.FSharpEntity: System.Collections.Generic.IList`1[FSharp.
FSharp.Compiler.Symbols.FSharpEntity: System.Collections.Generic.IList`1[FSharp.Compiler.Symbols.FSharpUnionCase] UnionCases
FSharp.Compiler.Symbols.FSharpEntity: System.Collections.Generic.IList`1[FSharp.Compiler.Symbols.FSharpUnionCase] get_UnionCases()
FSharp.Compiler.Symbols.FSharpEntity: System.String AccessPath
FSharp.Compiler.Symbols.FSharpEntity: System.String BasicQualifiedName
FSharp.Compiler.Symbols.FSharpEntity: System.String CompiledName
FSharp.Compiler.Symbols.FSharpEntity: System.String DisplayName
FSharp.Compiler.Symbols.FSharpEntity: System.String FullName
Expand All @@ -4559,6 +4561,7 @@ FSharp.Compiler.Symbols.FSharpEntity: System.String QualifiedName
FSharp.Compiler.Symbols.FSharpEntity: System.String ToString()
FSharp.Compiler.Symbols.FSharpEntity: System.String XmlDocSig
FSharp.Compiler.Symbols.FSharpEntity: System.String get_AccessPath()
FSharp.Compiler.Symbols.FSharpEntity: System.String get_BasicQualifiedName()
FSharp.Compiler.Symbols.FSharpEntity: System.String get_CompiledName()
FSharp.Compiler.Symbols.FSharpEntity: System.String get_DisplayName()
FSharp.Compiler.Symbols.FSharpEntity: System.String get_FullName()
Expand Down Expand Up @@ -4864,6 +4867,7 @@ FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean IsOverrideOrExpli
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean IsProperty
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean IsPropertyGetterMethod
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean IsPropertySetterMethod
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean IsRefCell
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean IsTypeFunction
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean IsUnresolved
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean IsValCompiledAsMethod
Expand Down Expand Up @@ -4895,6 +4899,7 @@ FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean get_IsOverrideOrE
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean get_IsProperty()
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean get_IsPropertyGetterMethod()
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean get_IsPropertySetterMethod()
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean get_IsRefCell()
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean get_IsTypeFunction()
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean get_IsUnresolved()
FSharp.Compiler.Symbols.FSharpMemberOrFunctionOrValue: Boolean get_IsValCompiledAsMethod()
Expand Down Expand Up @@ -5111,7 +5116,9 @@ FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Symbols.FSharpType Abbreviat
FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Symbols.FSharpType Instantiate(Microsoft.FSharp.Collections.FSharpList`1[System.Tuple`2[FSharp.Compiler.Symbols.FSharpGenericParameter,FSharp.Compiler.Symbols.FSharpType]])
FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Symbols.FSharpType Prettify(FSharp.Compiler.Symbols.FSharpType)
FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Symbols.FSharpType StripAbbreviations()
FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Symbols.FSharpType ErasedType
FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Symbols.FSharpType get_AbbreviatedType()
FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Symbols.FSharpType get_ErasedType()
FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Text.TaggedText[] FormatLayout(FSharp.Compiler.Symbols.FSharpDisplayContext)
FSharp.Compiler.Symbols.FSharpType: FSharp.Compiler.Text.TaggedText[] FormatLayoutWithConstraints(FSharp.Compiler.Symbols.FSharpDisplayContext)
FSharp.Compiler.Symbols.FSharpType: Int32 GetHashCode()
Expand All @@ -5124,9 +5131,11 @@ FSharp.Compiler.Symbols.FSharpType: System.Collections.Generic.IList`1[FSharp.Co
FSharp.Compiler.Symbols.FSharpType: System.Collections.Generic.IList`1[FSharp.Compiler.Symbols.FSharpType] get_AllInterfaces()
FSharp.Compiler.Symbols.FSharpType: System.Collections.Generic.IList`1[FSharp.Compiler.Symbols.FSharpType] get_GenericArguments()
FSharp.Compiler.Symbols.FSharpType: System.Collections.Generic.IList`1[System.Collections.Generic.IList`1[FSharp.Compiler.Symbols.FSharpParameter]] Prettify(System.Collections.Generic.IList`1[System.Collections.Generic.IList`1[FSharp.Compiler.Symbols.FSharpParameter]])
FSharp.Compiler.Symbols.FSharpType: System.String BasicQualifiedName
FSharp.Compiler.Symbols.FSharpType: System.String Format(FSharp.Compiler.Symbols.FSharpDisplayContext)
FSharp.Compiler.Symbols.FSharpType: System.String FormatWithConstraints(FSharp.Compiler.Symbols.FSharpDisplayContext)
FSharp.Compiler.Symbols.FSharpType: System.String ToString()
FSharp.Compiler.Symbols.FSharpType: System.String get_BasicQualifiedName()
FSharp.Compiler.Symbols.FSharpType: System.Tuple`2[System.Collections.Generic.IList`1[System.Collections.Generic.IList`1[FSharp.Compiler.Symbols.FSharpParameter]],FSharp.Compiler.Symbols.FSharpParameter] Prettify(System.Collections.Generic.IList`1[System.Collections.Generic.IList`1[FSharp.Compiler.Symbols.FSharpParameter]], FSharp.Compiler.Symbols.FSharpParameter)
FSharp.Compiler.Symbols.FSharpUnionCase
FSharp.Compiler.Symbols.FSharpUnionCase: Boolean Equals(System.Object)
Expand Down