// Copyright (c) Microsoft Corporation.  All Rights Reserved.  See License.txt in the project root for license information.

// Type providers, validation of provided types, etc.

module internal rec FSharp.Compiler.TypeProviders

#if !NO_TYPEPROVIDERS

open System
open System.Collections.Concurrent
open System.IO
open System.Collections.Generic
open System.Reflection
open Internal.Utilities.Library
open Internal.Utilities.FSharpEnvironment  
open FSharp.Core.CompilerServices
open FSharp.Quotations
open FSharp.Compiler.AbstractIL.IL
open FSharp.Compiler.DiagnosticsLogger
open FSharp.Compiler.Syntax
open FSharp.Compiler.Text
open FSharp.Compiler.Text.Range

type TypeProviderDesignation = TypeProviderDesignation of string

exception ProvidedTypeResolution of range * exn

exception ProvidedTypeResolutionNoRange of exn

let toolingCompatiblePaths() = Internal.Utilities.FSharpEnvironment.toolingCompatiblePaths ()

/// Represents some of the configuration parameters passed to type provider components 
type ResolutionEnvironment =
    { ResolutionFolder: string
      OutputFile: string option
      ShowResolutionMessages: bool
      GetReferencedAssemblies: unit -> string[]
      TemporaryFolder: string }

/// Load a the design-time part of a type-provider into the host process, and look for types
/// marked with the TypeProviderAttribute attribute.
let GetTypeProviderImplementationTypes (
        runTimeAssemblyFileName,
        designTimeAssemblyNameString,
        m:range,
        compilerToolPaths:string list
    ) =

    // Report an error, blaming the particular type provider component
    let raiseError designTimeAssemblyPathOpt (e: exn) =
        let attrName = typeof<TypeProviderAssemblyAttribute>.Name
        let exnTypeName = e.GetType().FullName
        let exnMsg = e.Message
        match designTimeAssemblyPathOpt with 
        | None -> 
            let msg = FSComp.SR.etProviderHasWrongDesignerAssemblyNoPath(attrName, designTimeAssemblyNameString, exnTypeName, exnMsg)
            raise (TypeProviderError(msg, runTimeAssemblyFileName, m))
        | Some designTimeAssemblyPath -> 
            let msg = FSComp.SR.etProviderHasWrongDesignerAssembly(attrName, designTimeAssemblyNameString, designTimeAssemblyPath, exnTypeName, exnMsg)
            raise (TypeProviderError(msg, runTimeAssemblyFileName, m))

    let designTimeAssemblyOpt = getTypeProviderAssembly (runTimeAssemblyFileName, designTimeAssemblyNameString, compilerToolPaths, raiseError)

    match designTimeAssemblyOpt with
    | Some loadedDesignTimeAssembly ->
        try
            let exportedTypes = loadedDesignTimeAssembly.GetExportedTypes() 
            let filtered = 
                [
                    for t in exportedTypes do 
                        let ca = t.GetCustomAttributes(typeof<TypeProviderAttribute>, true)
                        match ca with 
                        | Null -> ()
                        | NonNull ca -> 
                            if ca.Length > 0 then 
                                yield t
                ]
            filtered
        with e ->
            let folder = Path.GetDirectoryName loadedDesignTimeAssembly.Location
            let exnTypeName = e.GetType().FullName
            let exnMsg = e.Message
            match e with 
            | :? FileLoadException -> 
                let msg = FSComp.SR.etProviderHasDesignerAssemblyDependency(designTimeAssemblyNameString, folder, exnTypeName, exnMsg)
                raise (TypeProviderError(msg, runTimeAssemblyFileName, m))
                
            | _ -> 
                let msg = FSComp.SR.etProviderHasDesignerAssemblyException(designTimeAssemblyNameString, folder, exnTypeName, exnMsg)
                raise (TypeProviderError(msg, runTimeAssemblyFileName, m))
    | None -> []

let StripException (e: exn) =
    match e with
    | :? TargetInvocationException as e -> e.InnerException
    | :? TypeInitializationException as e -> e.InnerException
    | _ -> e

/// Create an instance of a type provider from the implementation type for the type provider in the
/// design-time assembly by using reflection-invoke on a constructor for the type provider.
let CreateTypeProvider (
        typeProviderImplementationType: Type, 
        runtimeAssemblyPath, 
        resolutionEnvironment: ResolutionEnvironment, 
        isInvalidationSupported: bool, 
        isInteractive: bool, 
        systemRuntimeContainsType, 
        systemRuntimeAssemblyVersion, 
        m
    ) =

    // Protect a .NET reflection call as we load the type provider component into the host process, 
    // reporting errors.
    let protect f =
        try 
            f ()
        with err ->
            let e = StripException (StripException err)
            raise (TypeProviderError(FSComp.SR.etTypeProviderConstructorException(e.Message), typeProviderImplementationType.FullName, m))

    let getReferencedAssemblies () =
        resolutionEnvironment.GetReferencedAssemblies() |> Array.distinct

    if not(isNull(typeProviderImplementationType.GetConstructor([| typeof<TypeProviderConfig> |]))) then

        // Create the TypeProviderConfig to pass to the type provider constructor
        let e =
#if FSHARPCORE_USE_PACKAGE
            TypeProviderConfig(systemRuntimeContainsType,
                ReferencedAssemblies=getReferencedAssemblies(),
                ResolutionFolder=resolutionEnvironment.ResolutionFolder, 
                RuntimeAssembly=runtimeAssemblyPath, 
                TemporaryFolder=resolutionEnvironment.TemporaryFolder, 
                IsInvalidationSupported=isInvalidationSupported, 
                IsHostedExecution= isInteractive, 
                SystemRuntimeAssemblyVersion = systemRuntimeAssemblyVersion)
#else
            TypeProviderConfig(systemRuntimeContainsType,
                ReferencedAssemblies=getReferencedAssemblies(),
                ResolutionFolder=resolutionEnvironment.ResolutionFolder, 
                RuntimeAssembly=runtimeAssemblyPath, 
                TemporaryFolder=resolutionEnvironment.TemporaryFolder, 
                IsInvalidationSupported=isInvalidationSupported, 
                IsHostedExecution= isInteractive, 
                SystemRuntimeAssemblyVersion = systemRuntimeAssemblyVersion)
#endif
        protect (fun () -> Activator.CreateInstance(typeProviderImplementationType, [| box e|]) :?> ITypeProvider )

    elif not(isNull(typeProviderImplementationType.GetConstructor [| |])) then 
        protect (fun () -> Activator.CreateInstance typeProviderImplementationType :?> ITypeProvider )

    else
        // No appropriate constructor found
        raise (TypeProviderError(FSComp.SR.etProviderDoesNotHaveValidConstructor(), typeProviderImplementationType.FullName, m))

let GetTypeProvidersOfAssembly (
        runtimeAssemblyFilename: string, 
        ilScopeRefOfRuntimeAssembly: ILScopeRef, 
        designTimeName: string, 
        resolutionEnvironment: ResolutionEnvironment, 
        isInvalidationSupported: bool, 
        isInteractive: bool, 
        systemRuntimeContainsType: string -> bool, 
        systemRuntimeAssemblyVersion: Version, 
        compilerToolPaths: string list,
        m:range
    ) =

    let providerSpecs = 
        try
            let designTimeAssemblyName = 
                try
                    if designTimeName.EndsWith(".dll", StringComparison.OrdinalIgnoreCase) then
                        Some (AssemblyName (Path.GetFileNameWithoutExtension designTimeName))
                    else
                        Some (AssemblyName designTimeName)
                with :? ArgumentException ->
                    errorR(Error(FSComp.SR.etInvalidTypeProviderAssemblyName(runtimeAssemblyFilename, designTimeName), m))
                    None

            [
                match designTimeAssemblyName, resolutionEnvironment.OutputFile with
                // Check if the attribute is pointing to the file being compiled, in which case ignore it
                // This checks seems like legacy but is included for compat.
                | Some designTimeAssemblyName, Some path 
                    when String.Compare(designTimeAssemblyName.Name, Path.GetFileNameWithoutExtension path, StringComparison.OrdinalIgnoreCase) = 0 ->
                    ()

                | Some _, _ ->
                    let provImplTypes = GetTypeProviderImplementationTypes (runtimeAssemblyFilename, designTimeName, m, compilerToolPaths)
                    for t in provImplTypes do
                        let resolver =
                            CreateTypeProvider (t, runtimeAssemblyFilename, resolutionEnvironment, isInvalidationSupported,
                                isInteractive, systemRuntimeContainsType, systemRuntimeAssemblyVersion, m)
                        match box resolver with 
                        | Null -> ()
                        | _ -> yield (resolver, ilScopeRefOfRuntimeAssembly)

                | None, _ -> 
                    ()
            ]

        with :? TypeProviderError as tpe ->
            tpe.Iter(fun e -> errorR(Error((e.Number, e.ContextualErrorMessage), m)) )
            []

    let providers = Tainted<_>.CreateAll(providerSpecs)

    providers

let unmarshal (t: Tainted<_>) = t.PUntaintNoFailure id

/// Try to access a member on a provided type, catching and reporting errors
let TryTypeMember<'T,'U>(st: Tainted<'T>, fullName, memberName, m, recover, f: 'T -> 'U) : Tainted<'U> =
    try
        st.PApply (f, m)
    with :? TypeProviderError as tpe -> 
        tpe.Iter (fun e -> errorR(Error(FSComp.SR.etUnexpectedExceptionFromProvidedTypeMember(fullName, memberName, e.ContextualErrorMessage), m)))
        st.PApplyNoFailure(fun _ -> recover)

/// Try to access a member on a provided type, where the result is an array of values, catching and reporting errors
let TryTypeMemberArray (st: Tainted<_>, fullName, memberName, m, f) =
    try
        st.PApplyArray(f, memberName, m)
    with :? TypeProviderError as tpe ->
        tpe.Iter (fun e -> error(Error(FSComp.SR.etUnexpectedExceptionFromProvidedTypeMember(fullName, memberName, e.ContextualErrorMessage), m)))
        [||]

/// Try to access a member on a provided type, catching and reporting errors and checking the result is non-null, 
let TryTypeMemberNonNull<'T, 'U when 'U : null and 'U : not struct>(st: Tainted<'T>, fullName, memberName, m, recover: 'U, (f: 'T -> 'U)) : Tainted<'U> =
    match TryTypeMember(st, fullName, memberName, m, recover, f) with 
    | Tainted.Null -> 
        errorR(Error(FSComp.SR.etUnexpectedNullFromProvidedTypeMember(fullName, memberName), m))
        st.PApplyNoFailure(fun _ -> recover)
    | Tainted.NonNull r ->
        r

/// Try to access a property or method on a provided member, catching and reporting errors
let TryMemberMember (mi: Tainted<_>, typeName, memberName, memberMemberName, m, recover, f) = 
    try
        mi.PApply (f, m)
    with :? TypeProviderError as tpe ->
        tpe.Iter (fun e -> errorR(Error(FSComp.SR.etUnexpectedExceptionFromProvidedMemberMember(memberMemberName, typeName, memberName, e.ContextualErrorMessage), m)))
        mi.PApplyNoFailure(fun _ -> recover)

/// Get the string to show for the name of a type provider
let DisplayNameOfTypeProvider(resolver: Tainted<ITypeProvider>, m: range) =
    resolver.PUntaint((fun tp -> tp.GetType().Name), m)

/// Validate a provided namespace name
let ValidateNamespaceName(name, typeProvider: Tainted<ITypeProvider>, m, nsp: string MaybeNull) =
    match nsp with 
    | Null -> ()
    | NonNull nsp -> 
        if String.IsNullOrWhiteSpace nsp then
            // Empty namespace is not allowed
            errorR(Error(FSComp.SR.etEmptyNamespaceOfTypeNotAllowed(name, typeProvider.PUntaint((fun tp -> tp.GetType().Name), m)), m))
        else
            for s in nsp.Split('.') do
                match s.IndexOfAny(PrettyNaming.IllegalCharactersInTypeAndNamespaceNames) with
                | -1 -> ()
                | n -> errorR(Error(FSComp.SR.etIllegalCharactersInNamespaceName(string s[n], s), m))  

let bindingFlags =
    BindingFlags.DeclaredOnly |||
    BindingFlags.Static |||
    BindingFlags.Instance |||
    BindingFlags.Public

// NOTE: for the purposes of remapping the closure of generated types, the FullName is sufficient.
// We do _not_ rely on object identity or any other notion of equivalence provided by System.Type
// itself. The mscorlib implementations of System.Type equality relations are not suitable: for
// example RuntimeType overrides the equality relation to be reference equality for the Equals(object)
// override, but the other subtypes of System.Type do not, making the relation non-reflective.
//
// Further, avoiding reliance on canonicalization (UnderlyingSystemType) or System.Type object identity means that 
// providers can implement wrap-and-filter "views" over existing System.Type clusters without needing
// to preserve object identity when presenting the types to the F# compiler.

type ProvidedTypeComparer() = 
    let key (ty: ProvidedType) =
        match ty.Assembly with
        | Null -> ("", ty.FullName)
        | NonNull a -> (a.FullName, ty.FullName)

    static member val Instance = ProvidedTypeComparer()

    interface IEqualityComparer<ProvidedType> with
        member _.GetHashCode(ty: ProvidedType) = hash (key ty)
        member _.Equals(ty1: ProvidedType, ty2: ProvidedType) = (key ty1 = key ty2)

/// The context used to interpret information in the closure of System.Type, System.MethodInfo and other 
/// info objects coming from the type provider.
///
/// This is the "Type --> Tycon" remapping context of the type. This is only present for generated provided types, and contains
/// all the entries in the remappings for the generative declaration.
///
/// Laziness is used "to prevent needless computation for every type during remapping". However it
/// appears that the laziness likely serves no purpose and could be safely removed.
type ProvidedTypeContext = 
    | NoEntries
    // The dictionaries are safe because the ProvidedType with the ProvidedTypeContext are only accessed one thread at a time during type-checking.
    | Entries of ConcurrentDictionary<ProvidedType, ILTypeRef> * InterruptibleLazy<ConcurrentDictionary<ProvidedType, obj>>

    static member Empty = NoEntries

    static member Create(d1, d2) = Entries(d1, notlazy d2)

    member ctxt.GetDictionaries()  = 
        match ctxt with
        | NoEntries -> 
            ConcurrentDictionary<ProvidedType, ILTypeRef>(ProvidedTypeComparer.Instance), ConcurrentDictionary<ProvidedType, obj>(ProvidedTypeComparer.Instance)
        | Entries (lookupILTR, lookupILTCR) ->
            lookupILTR, lookupILTCR.Force()

    member ctxt.TryGetILTypeRef st = 
        match ctxt with 
        | NoEntries -> None 
        | Entries(d, _) -> 
            match d.TryGetValue st with
            | true, res -> Some res
            | _ -> None

    member ctxt.TryGetTyconRef st = 
        match ctxt with 
        | NoEntries -> None 
        | Entries(_, d) -> 
            let d = d.Force()
            match d.TryGetValue st with
            | true, res -> Some res
            | _ -> None

    member ctxt.RemapTyconRefs (f: obj->obj) = 
        match ctxt with 
        | NoEntries -> NoEntries
        | Entries(d1, d2) ->
            Entries(d1, InterruptibleLazy(fun _ ->
                let dict = ConcurrentDictionary<ProvidedType, obj>(ProvidedTypeComparer.Instance)
                for KeyValue (st, tcref) in d2.Force() do dict.TryAdd(st, f tcref) |> ignore
                dict
            ))

[<AllowNullLiteral; Sealed>]
type ProvidedType (x: Type, ctxt: ProvidedTypeContext) =
    inherit ProvidedMemberInfo(x, ctxt)

    let isMeasure = 
        lazy
            x.CustomAttributes 
            |> Seq.exists (fun a -> a.Constructor.DeclaringType.FullName = typeof<MeasureAttribute>.FullName)

    let provide () = ProvidedCustomAttributeProvider (fun _ -> x.CustomAttributes) :> IProvidedCustomAttributeProvider

    interface IProvidedCustomAttributeProvider with 
        member _.GetHasTypeProviderEditorHideMethodsAttribute provider = provide().GetHasTypeProviderEditorHideMethodsAttribute provider
        member _.GetDefinitionLocationAttribute provider = provide().GetDefinitionLocationAttribute provider
        member _.GetXmlDocAttributes provider = provide().GetXmlDocAttributes provider
        
    // The type provider spec distinguishes between 
    //   - calls that can be made on provided types (i.e. types given by ReturnType, ParameterType, and generic argument types)
    //   - calls that can be made on provided type definitions (types returned by ResolveTypeName, GetTypes etc.)
    // Ideally we would enforce this decision structurally by having both ProvidedType and ProvidedTypeDefinition.
    // Alternatively we could use assertions to enforce this.

    // Suppress relocation of generated types
    member _.IsSuppressRelocate = (x.Attributes &&& enum (int32 TypeProviderTypeAttributes.SuppressRelocate)) <> enum 0  

    member _.IsErased = (x.Attributes &&& enum (int32 TypeProviderTypeAttributes.IsErased)) <> enum 0  

    member _.IsGenericType = x.IsGenericType

    member _.Namespace : string MaybeNull = x.Namespace

    member _.FullName = x.FullName

    member _.IsArray = x.IsArray

    member _.Assembly: ProvidedAssembly MaybeNull = x.Assembly |> ProvidedAssembly.Create

    member _.GetInterfaces() = x.GetInterfaces() |> ProvidedType.CreateArray ctxt

    member _.GetMethods() = x.GetMethods bindingFlags |> ProvidedMethodInfo.CreateArray ctxt

    member _.GetEvents() = x.GetEvents bindingFlags |> ProvidedEventInfo.CreateArray ctxt

    member _.GetEvent nm = x.GetEvent(nm, bindingFlags) |> ProvidedEventInfo.Create ctxt

    member _.GetProperties() = x.GetProperties bindingFlags |> ProvidedPropertyInfo.CreateArray ctxt

    member _.GetProperty nm = x.GetProperty(nm, bindingFlags) |> ProvidedPropertyInfo.Create ctxt

    member _.GetConstructors() = x.GetConstructors bindingFlags |> ProvidedConstructorInfo.CreateArray ctxt

    member _.GetFields() = x.GetFields bindingFlags |> ProvidedFieldInfo.CreateArray ctxt

    member _.GetField nm = x.GetField(nm, bindingFlags) |> ProvidedFieldInfo.Create ctxt

    member _.GetAllNestedTypes() = x.GetNestedTypes(bindingFlags ||| BindingFlags.NonPublic) |> ProvidedType.CreateArray ctxt

    member _.GetNestedTypes() = x.GetNestedTypes bindingFlags |> ProvidedType.CreateArray ctxt

    /// Type.GetNestedType(string) can return null if there is no nested type with given name
    member _.GetNestedType nm = x.GetNestedType (nm, bindingFlags) |> ProvidedType.Create ctxt

    /// Type.GetGenericTypeDefinition() either returns type or throws exception, null is not permitted
    member _.GetGenericTypeDefinition() = x.GetGenericTypeDefinition() |> ProvidedType.CreateWithNullCheck ctxt "GenericTypeDefinition"

    /// Type.BaseType can be null when Type is interface or object
    member _.BaseType = x.BaseType |> ProvidedType.Create ctxt

    member _.GetStaticParameters(provider: ITypeProvider) = provider.GetStaticParameters x |> ProvidedParameterInfo.CreateArray ctxt

    /// Type.GetElementType can be null if i.e. Type is not array\pointer\byref type
    member _.GetElementType() = x.GetElementType() |> ProvidedType.Create ctxt

    member _.GetGenericArguments() = x.GetGenericArguments() |> ProvidedType.CreateArray ctxt

    member _.ApplyStaticArguments(provider: ITypeProvider, fullTypePathAfterArguments, staticArgs: obj[]) = 
        provider.ApplyStaticArguments(x, fullTypePathAfterArguments,  staticArgs) |> ProvidedType.Create ctxt

    member _.IsVoid = (Type.op_Equality(x, typeof<Void>) || (x.Namespace = "System" && x.Name = "Void"))

    member _.IsGenericParameter = x.IsGenericParameter

    member _.IsValueType = x.IsValueType

    member _.IsByRef = x.IsByRef

    member _.IsPointer = x.IsPointer

    member _.IsPublic = x.IsPublic

    member _.IsNestedPublic = x.IsNestedPublic

    member _.IsEnum = x.IsEnum

    member _.IsClass = x.IsClass

    member _.IsMeasure = isMeasure.Value

    member _.IsSealed = x.IsSealed

    member _.IsAbstract = x.IsAbstract

    member _.IsInterface = x.IsInterface

    member _.GetArrayRank() = x.GetArrayRank()

    member _.GenericParameterPosition = x.GenericParameterPosition

    member _.RawSystemType = x

    /// Type.GetEnumUnderlyingType either returns type or raises exception, null is not permitted
    member _.GetEnumUnderlyingType() = 
        x.GetEnumUnderlyingType() 
        |> ProvidedType.CreateWithNullCheck ctxt "EnumUnderlyingType"    

    member _.MakePointerType() = ProvidedType.CreateNoContext(x.MakePointerType())

    member _.MakeByRefType() = ProvidedType.CreateNoContext(x.MakeByRefType())

    member _.MakeArrayType() = ProvidedType.CreateNoContext(x.MakeArrayType())

    member _.MakeArrayType rank = ProvidedType.CreateNoContext(x.MakeArrayType(rank))

    member _.MakeGenericType (args: ProvidedType[]) =
        let argTypes = args |> Array.map (fun arg -> arg.RawSystemType)
        ProvidedType.CreateNoContext(x.MakeGenericType(argTypes))

    member _.AsProvidedVar name = ProvidedVar.Create ctxt (Var(name, x))

    static member Create ctxt x = match x with null -> null | t -> ProvidedType (t, ctxt)

    static member CreateWithNullCheck ctxt name x = match x with null -> nullArg name | t -> ProvidedType (t, ctxt)

    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedType.Create ctxt)

    static member CreateNoContext (x: Type) = ProvidedType.Create ProvidedTypeContext.Empty x

    static member Void = ProvidedType.CreateNoContext typeof<Void>

    member _.Handle = x

    override _.Equals y = assert false; match y with :? ProvidedType as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = assert false; x.GetHashCode()

    member _.Context = ctxt

    member this.TryGetILTypeRef() = this.Context.TryGetILTypeRef this

    member this.TryGetTyconRef() = this.Context.TryGetTyconRef this

    static member ApplyContext (pt: ProvidedType, ctxt) = ProvidedType(pt.Handle, ctxt)

    static member TaintedEquals (pt1: Tainted<ProvidedType>, pt2: Tainted<ProvidedType>) = 
        Tainted.EqTainted (pt1.PApplyNoFailure(fun st -> st.Handle)) (pt2.PApplyNoFailure(fun st -> st.Handle))

[<AllowNullLiteral>] 
type IProvidedCustomAttributeProvider =
    abstract GetDefinitionLocationAttribute: provider: ITypeProvider -> (string * int * int) option 
    abstract GetXmlDocAttributes: provider: ITypeProvider -> string[]
    abstract GetHasTypeProviderEditorHideMethodsAttribute: provider: ITypeProvider -> bool
    abstract GetAttributeConstructorArgs: provider: ITypeProvider * attribName: string -> (obj option list * (string * obj option) list) option

type ProvidedCustomAttributeProvider (attributes :ITypeProvider -> seq<CustomAttributeData>) = 
    let (|Member|_|) (s: string) (x: CustomAttributeNamedArgument) = if x.MemberName = s then Some x.TypedValue else None
    let (|Arg|_|) (x: CustomAttributeTypedArgument) = match x.Value with null -> None | v -> Some v
    let findAttribByName tyFullName (a: CustomAttributeData) = (a.Constructor.DeclaringType.FullName = tyFullName)  
    let findAttrib (ty: Type) a = findAttribByName ty.FullName a
    interface IProvidedCustomAttributeProvider with 
        member _.GetAttributeConstructorArgs (provider, attribName) = 
            attributes provider 
            |> Seq.tryFind (findAttribByName  attribName)  
            |> Option.map (fun a -> 
                let ctorArgs = 
                    a.ConstructorArguments 
                    |> Seq.toList 
                    |> List.map (function Arg null -> None | Arg obj -> Some obj | _ -> None)
                let namedArgs = 
                    a.NamedArguments 
                    |> Seq.toList 
                    |> List.map (fun arg -> arg.MemberName, match arg.TypedValue with Arg null -> None | Arg obj -> Some obj | _ -> None)
                ctorArgs, namedArgs)

        member _.GetHasTypeProviderEditorHideMethodsAttribute provider = 
            attributes provider 
            |> Seq.exists (findAttrib typeof<TypeProviderEditorHideMethodsAttribute>) 

        member _.GetDefinitionLocationAttribute provider = 
            attributes provider 
            |> Seq.tryFind (findAttrib  typeof<TypeProviderDefinitionLocationAttribute>)  
            |> Option.map (fun a -> 
                let filePath = defaultArg (a.NamedArguments |> Seq.tryPick (function Member "FilePath" (Arg (:? string as v)) -> Some v | _ -> None)) null
                let line = defaultArg (a.NamedArguments |> Seq.tryPick (function Member "Line" (Arg (:? int as v)) -> Some v | _ -> None)) 0
                let column = defaultArg (a.NamedArguments |> Seq.tryPick (function Member "Column" (Arg (:? int as v)) -> Some v | _ -> None)) 0
                (filePath, line, column))

        member _.GetXmlDocAttributes provider = 
            attributes provider 
            |> Seq.choose (fun a -> 
                if findAttrib  typeof<TypeProviderXmlDocAttribute> a then 
                    match a.ConstructorArguments |> Seq.toList with 
                    | [ Arg(:? string as s) ] -> Some s
                    | _ -> None
                else 
                    None) 
            |> Seq.toArray

[<AllowNullLiteral; AbstractClass>] 
type ProvidedMemberInfo (x: MemberInfo, ctxt) = 
    let provide () = ProvidedCustomAttributeProvider (fun _ -> x.CustomAttributes) :> IProvidedCustomAttributeProvider

    member _.Name = x.Name

    /// DeclaringType can be null if MemberInfo belongs to Module, not to Type
    member _.DeclaringType = ProvidedType.Create ctxt x.DeclaringType

    interface IProvidedCustomAttributeProvider with 
        member _.GetHasTypeProviderEditorHideMethodsAttribute provider =
            provide().GetHasTypeProviderEditorHideMethodsAttribute provider

        member _.GetDefinitionLocationAttribute provider =
            provide().GetDefinitionLocationAttribute provider

        member _.GetXmlDocAttributes provider =
            provide().GetXmlDocAttributes provider

        member _.GetAttributeConstructorArgs (provider, attribName) =
            provide().GetAttributeConstructorArgs (provider, attribName)

[<AllowNullLiteral; Sealed>] 
type ProvidedParameterInfo (x: ParameterInfo, ctxt) = 
    let provide () = ProvidedCustomAttributeProvider (fun _ -> x.CustomAttributes) :> IProvidedCustomAttributeProvider

    member _.Name = x.Name

    member _.IsOut = x.IsOut

    member _.IsIn = x.IsIn

    member _.IsOptional = x.IsOptional

    member _.RawDefaultValue = x.RawDefaultValue

    member _.HasDefaultValue = x.Attributes.HasFlag(ParameterAttributes.HasDefault)

    /// ParameterInfo.ParameterType cannot be null
    member _.ParameterType = ProvidedType.CreateWithNullCheck ctxt "ParameterType" x.ParameterType 

    static member Create ctxt x = match x with null -> null | t -> ProvidedParameterInfo (t, ctxt)

    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedParameterInfo.Create ctxt)  // TODO null wrong?

    interface IProvidedCustomAttributeProvider with 
        member _.GetHasTypeProviderEditorHideMethodsAttribute provider =
            provide().GetHasTypeProviderEditorHideMethodsAttribute provider

        member _.GetDefinitionLocationAttribute provider =
            provide().GetDefinitionLocationAttribute provider

        member _.GetXmlDocAttributes provider =
            provide().GetXmlDocAttributes provider

        member _.GetAttributeConstructorArgs (provider, attribName) =
            provide().GetAttributeConstructorArgs (provider, attribName)

    member _.Handle = x

    override _.Equals y = assert false; match y with :? ProvidedParameterInfo as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = assert false; x.GetHashCode()

[<AllowNullLiteral; Sealed>] 
type ProvidedAssembly (x: Assembly) = 

    member _.GetName() = x.GetName()

    member _.FullName = x.FullName

    member _.GetManifestModuleContents(provider: ITypeProvider) = provider.GetGeneratedAssemblyContents x

    static member Create (x: Assembly) = match x with null -> null | t -> ProvidedAssembly t

    member _.Handle = x

    override _.Equals y = assert false; match y with :? ProvidedAssembly as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = assert false; x.GetHashCode()

[<AllowNullLiteral; AbstractClass>] 
type ProvidedMethodBase (x: MethodBase, ctxt) = 
    inherit ProvidedMemberInfo(x, ctxt)

    member _.Context = ctxt

    member _.IsGenericMethod = x.IsGenericMethod

    member _.IsStatic  = x.IsStatic

    member _.IsFamily  = x.IsFamily

    member _.IsFamilyOrAssembly = x.IsFamilyOrAssembly

    member _.IsFamilyAndAssembly = x.IsFamilyAndAssembly

    member _.IsVirtual  = x.IsVirtual

    member _.IsFinal = x.IsFinal

    member _.IsPublic = x.IsPublic

    member _.IsAbstract  = x.IsAbstract

    member _.IsHideBySig = x.IsHideBySig

    member _.IsConstructor  = x.IsConstructor

    member _.GetParameters() = x.GetParameters() |> ProvidedParameterInfo.CreateArray ctxt 

    member _.GetGenericArguments() = x.GetGenericArguments() |> ProvidedType.CreateArray ctxt

    member _.Handle = x

    static member TaintedGetHashCode (x: Tainted<ProvidedMethodBase>) =            
        Tainted.GetHashCodeTainted (x.PApplyNoFailure(fun st -> (st.Name, st.DeclaringType.Assembly.FullName, st.DeclaringType.FullName))) 

    static member TaintedEquals (pt1: Tainted<ProvidedMethodBase>, pt2: Tainted<ProvidedMethodBase>) = 
        Tainted.EqTainted (pt1.PApplyNoFailure(fun st -> st.Handle)) (pt2.PApplyNoFailure(fun st -> st.Handle))

    member _.GetStaticParametersForMethod(provider: ITypeProvider) = 
        let bindingFlags = BindingFlags.Instance ||| BindingFlags.NonPublic ||| BindingFlags.Public 

        let staticParams = 
            match provider with 
            | :? ITypeProvider2 as itp2 -> 
                itp2.GetStaticParametersForMethod x  
            | _ -> 
                // To allow a type provider to depend only on FSharp.Core 4.3.0.0, it can alternatively
                // implement an appropriate method called GetStaticParametersForMethod
                let meth =
                    provider.GetType().GetMethod( "GetStaticParametersForMethod", bindingFlags, null,
                        [| typeof<MethodBase> |], null)  
                if isNull meth then [| |] else
                let paramsAsObj = 
                    try meth.Invoke(provider, bindingFlags ||| BindingFlags.InvokeMethod, null, [| box x |], null) 
                    with err -> raise (StripException (StripException err))
                paramsAsObj :?> ParameterInfo[] 

        staticParams |> ProvidedParameterInfo.CreateArray ctxt

    member _.ApplyStaticArgumentsForMethod(provider: ITypeProvider, fullNameAfterArguments: string, staticArgs: obj[]) = 
        let bindingFlags = BindingFlags.Instance ||| BindingFlags.Public ||| BindingFlags.InvokeMethod

        let mb = 
            match provider with 
            | :? ITypeProvider2 as itp2 -> 
                itp2.ApplyStaticArgumentsForMethod(x, fullNameAfterArguments, staticArgs)  
            | _ -> 

                // To allow a type provider to depend only on FSharp.Core 4.3.0.0, it can alternatively implement a method called GetStaticParametersForMethod
                let meth =
                    provider.GetType().GetMethod( "ApplyStaticArgumentsForMethod", bindingFlags, null,
                        [| typeof<MethodBase>; typeof<string>; typeof<obj[]> |], null)  

                match meth with 
                | null -> failwith (FSComp.SR.estApplyStaticArgumentsForMethodNotImplemented())
                | _ -> 
                let mbAsObj = 
                    try meth.Invoke(provider, bindingFlags ||| BindingFlags.InvokeMethod, null, [| box x; box fullNameAfterArguments; box staticArgs  |], null) 
                    with err -> raise (StripException (StripException err))

                match mbAsObj with 
                | :? MethodBase as mb -> mb
                | _ -> failwith (FSComp.SR.estApplyStaticArgumentsForMethodNotImplemented())
        match mb with 
        | :? MethodInfo as mi -> (mi |> ProvidedMethodInfo.Create ctxt: ProvidedMethodInfo) :> ProvidedMethodBase
        | :? ConstructorInfo as ci -> (ci |> ProvidedConstructorInfo.Create ctxt: ProvidedConstructorInfo) :> ProvidedMethodBase
        | _ -> failwith (FSComp.SR.estApplyStaticArgumentsForMethodNotImplemented())


[<AllowNullLiteral; Sealed>] 
type ProvidedFieldInfo (x: FieldInfo, ctxt) = 
    inherit ProvidedMemberInfo(x, ctxt)

    static member Create ctxt x = match x with null -> null | t -> ProvidedFieldInfo (t, ctxt)

    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedFieldInfo.Create ctxt)

    member _.IsInitOnly = x.IsInitOnly

    member _.IsStatic = x.IsStatic

    member _.IsSpecialName = x.IsSpecialName

    member _.IsLiteral = x.IsLiteral

    member _.GetRawConstantValue() = x.GetRawConstantValue()

    /// FieldInfo.FieldType cannot be null

    member _.FieldType = x.FieldType |> ProvidedType.CreateWithNullCheck ctxt "FieldType" 

    member _.Handle = x

    member _.IsPublic = x.IsPublic

    member _.IsFamily = x.IsFamily

    member _.IsPrivate = x.IsPrivate

    member _.IsFamilyOrAssembly = x.IsFamilyOrAssembly

    member _.IsFamilyAndAssembly = x.IsFamilyAndAssembly

    override _.Equals y = assert false; match y with :? ProvidedFieldInfo as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = assert false; x.GetHashCode()

    static member TaintedEquals (pt1: Tainted<ProvidedFieldInfo>, pt2: Tainted<ProvidedFieldInfo>) = 
        Tainted.EqTainted (pt1.PApplyNoFailure(fun st -> st.Handle)) (pt2.PApplyNoFailure(fun st -> st.Handle))

[<AllowNullLiteral; Sealed>] 
type ProvidedMethodInfo (x: MethodInfo, ctxt) = 
    inherit ProvidedMethodBase(x, ctxt)

    member _.ReturnType = x.ReturnType |> ProvidedType.CreateWithNullCheck ctxt "ReturnType"

    static member Create ctxt x = match x with null -> null | t -> ProvidedMethodInfo (t, ctxt)

    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedMethodInfo.Create ctxt)

    member _.Handle = x

    member _.MetadataToken = x.MetadataToken

    override _.Equals y = assert false; match y with :? ProvidedMethodInfo as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = assert false; x.GetHashCode()

[<AllowNullLiteral; Sealed>] 
type ProvidedPropertyInfo (x: PropertyInfo, ctxt) = 
    inherit ProvidedMemberInfo(x, ctxt)

    member _.GetGetMethod() = x.GetGetMethod() |> ProvidedMethodInfo.Create ctxt

    member _.GetSetMethod() = x.GetSetMethod() |> ProvidedMethodInfo.Create ctxt

    member _.CanRead = x.CanRead

    member _.CanWrite = x.CanWrite

    member _.GetIndexParameters() = x.GetIndexParameters() |> ProvidedParameterInfo.CreateArray ctxt

    /// PropertyInfo.PropertyType cannot be null
    member _.PropertyType = x.PropertyType |> ProvidedType.CreateWithNullCheck ctxt "PropertyType"

    static member Create ctxt x = match x with null -> null | t -> ProvidedPropertyInfo (t, ctxt)

    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedPropertyInfo.Create ctxt)

    member _.Handle = x

    override _.Equals y = assert false; match y with :? ProvidedPropertyInfo as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = assert false; x.GetHashCode()

    static member TaintedGetHashCode (x: Tainted<ProvidedPropertyInfo>) = 
        Tainted.GetHashCodeTainted (x.PApplyNoFailure(fun st -> (st.Name, st.DeclaringType.Assembly.FullName, st.DeclaringType.FullName))) 

    static member TaintedEquals (pt1: Tainted<ProvidedPropertyInfo>, pt2: Tainted<ProvidedPropertyInfo>) = 
        Tainted.EqTainted (pt1.PApplyNoFailure(fun st -> st.Handle)) (pt2.PApplyNoFailure(fun st -> st.Handle))

[<AllowNullLiteral; Sealed>] 
type ProvidedEventInfo (x: EventInfo, ctxt) = 
    inherit ProvidedMemberInfo(x, ctxt)

    member _.GetAddMethod() = x.GetAddMethod() |> ProvidedMethodInfo.Create  ctxt

    member _.GetRemoveMethod() = x.GetRemoveMethod() |> ProvidedMethodInfo.Create ctxt

    /// EventInfo.EventHandlerType cannot be null
    member _.EventHandlerType = x.EventHandlerType |> ProvidedType.CreateWithNullCheck ctxt "EventHandlerType"

    static member Create ctxt x = match x with null -> null | t -> ProvidedEventInfo (t, ctxt)

    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedEventInfo.Create ctxt)

    member _.Handle = x

    override _.Equals y = assert false; match y with :? ProvidedEventInfo as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = assert false; x.GetHashCode()

    static member TaintedGetHashCode (x: Tainted<ProvidedEventInfo>) = 
        Tainted.GetHashCodeTainted (x.PApplyNoFailure(fun st -> (st.Name, st.DeclaringType.Assembly.FullName, st.DeclaringType.FullName))) 

    static member TaintedEquals (pt1: Tainted<ProvidedEventInfo>, pt2: Tainted<ProvidedEventInfo>) = 
        Tainted.EqTainted (pt1.PApplyNoFailure(fun st -> st.Handle)) (pt2.PApplyNoFailure(fun st -> st.Handle))

[<AllowNullLiteral; Sealed>] 
type ProvidedConstructorInfo (x: ConstructorInfo, ctxt) = 
    inherit ProvidedMethodBase(x, ctxt)

    static member Create ctxt x = match x with null -> null | t -> ProvidedConstructorInfo (t, ctxt)

    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedConstructorInfo.Create ctxt)

    member _.Handle = x

    override _.Equals y = assert false; match y with :? ProvidedConstructorInfo as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = assert false; x.GetHashCode()

type ProvidedExprType =
    | ProvidedNewArrayExpr of ProvidedType * ProvidedExpr[]
#if PROVIDED_ADDRESS_OF
    | ProvidedAddressOfExpr of ProvidedExpr
#endif
    | ProvidedNewObjectExpr of ProvidedConstructorInfo * ProvidedExpr[]
    | ProvidedWhileLoopExpr of ProvidedExpr * ProvidedExpr
    | ProvidedNewDelegateExpr of ProvidedType * ProvidedVar[] * ProvidedExpr
    | ProvidedForIntegerRangeLoopExpr of ProvidedVar * ProvidedExpr * ProvidedExpr * ProvidedExpr
    | ProvidedSequentialExpr of ProvidedExpr * ProvidedExpr
    | ProvidedTryWithExpr of ProvidedExpr * ProvidedVar * ProvidedExpr * ProvidedVar * ProvidedExpr
    | ProvidedTryFinallyExpr of ProvidedExpr * ProvidedExpr
    | ProvidedLambdaExpr of ProvidedVar * ProvidedExpr
    | ProvidedCallExpr of ProvidedExpr option * ProvidedMethodInfo * ProvidedExpr[] 
    | ProvidedConstantExpr of obj * ProvidedType
    | ProvidedDefaultExpr of ProvidedType
    | ProvidedNewTupleExpr of ProvidedExpr[]
    | ProvidedTupleGetExpr of ProvidedExpr * int
    | ProvidedTypeAsExpr of ProvidedExpr * ProvidedType
    | ProvidedTypeTestExpr of ProvidedExpr * ProvidedType
    | ProvidedLetExpr of ProvidedVar * ProvidedExpr * ProvidedExpr
    | ProvidedVarSetExpr of ProvidedVar * ProvidedExpr
    | ProvidedIfThenElseExpr of ProvidedExpr * ProvidedExpr * ProvidedExpr
    | ProvidedVarExpr of ProvidedVar

[<RequireQualifiedAccess; Class; AllowNullLiteral; Sealed>]
type ProvidedExpr (x: Expr, ctxt) =

    member _.Type = x.Type |> ProvidedType.Create ctxt

    member _.Handle = x

    member _.Context = ctxt

    member _.UnderlyingExpressionString = x.ToString()

    member _.GetExprType() =
        match x with
        | Patterns.NewObject(ctor, args) ->
            Some (ProvidedNewObjectExpr (ProvidedConstructorInfo.Create ctxt ctor, [| for a in args -> ProvidedExpr.Create ctxt a |]))
        | Patterns.WhileLoop(guardExpr, bodyExpr) ->
            Some (ProvidedWhileLoopExpr (ProvidedExpr.Create ctxt guardExpr, ProvidedExpr.Create ctxt bodyExpr))
        | Patterns.NewDelegate(ty, vs, expr) ->
            Some (ProvidedNewDelegateExpr(ProvidedType.Create ctxt ty, ProvidedVar.CreateArray ctxt (List.toArray vs), ProvidedExpr.Create ctxt expr))
        | Patterns.Call(objOpt, meth, args) ->
            Some (ProvidedCallExpr((match objOpt with None -> None | Some obj -> Some (ProvidedExpr.Create ctxt obj)), 
                    ProvidedMethodInfo.Create ctxt meth, [| for a in args -> ProvidedExpr.Create ctxt a |]))
        | Patterns.DefaultValue ty ->
            Some (ProvidedDefaultExpr (ProvidedType.Create ctxt ty))
        | Patterns.Value(obj, ty) ->
            Some (ProvidedConstantExpr (obj, ProvidedType.Create ctxt ty))
        | Patterns.Coerce(arg, ty) ->
            Some (ProvidedTypeAsExpr (ProvidedExpr.Create ctxt arg, ProvidedType.Create ctxt ty))
        | Patterns.NewTuple args ->
            Some (ProvidedNewTupleExpr(ProvidedExpr.CreateArray ctxt (Array.ofList args)))
        | Patterns.TupleGet(arg, n) ->
            Some (ProvidedTupleGetExpr (ProvidedExpr.Create ctxt arg, n))
        | Patterns.NewArray(ty, args) ->
            Some (ProvidedNewArrayExpr(ProvidedType.Create ctxt ty, ProvidedExpr.CreateArray ctxt (Array.ofList args)))
        | Patterns.Sequential(e1, e2) ->
            Some (ProvidedSequentialExpr(ProvidedExpr.Create ctxt e1, ProvidedExpr.Create ctxt e2))
        | Patterns.Lambda(v, body) ->
            Some (ProvidedLambdaExpr (ProvidedVar.Create ctxt v,  ProvidedExpr.Create ctxt body))
        | Patterns.TryFinally(b1, b2) ->
            Some (ProvidedTryFinallyExpr (ProvidedExpr.Create ctxt b1, ProvidedExpr.Create ctxt b2))
        | Patterns.TryWith(b, v1, e1, v2, e2) ->
            Some (ProvidedTryWithExpr (ProvidedExpr.Create ctxt b, ProvidedVar.Create ctxt v1, ProvidedExpr.Create ctxt e1, ProvidedVar.Create ctxt v2, ProvidedExpr.Create ctxt e2))
#if PROVIDED_ADDRESS_OF
        | Patterns.AddressOf e -> Some (ProvidedAddressOfExpr (ProvidedExpr.Create ctxt e))
#endif
        | Patterns.TypeTest(e, ty) ->
            Some (ProvidedTypeTestExpr(ProvidedExpr.Create ctxt e, ProvidedType.Create ctxt ty))
        | Patterns.Let(v, e, b) ->
            Some (ProvidedLetExpr (ProvidedVar.Create ctxt v, ProvidedExpr.Create ctxt e, ProvidedExpr.Create ctxt b))
        | Patterns.ForIntegerRangeLoop (v, e1, e2, e3) ->
            Some (ProvidedForIntegerRangeLoopExpr (ProvidedVar.Create ctxt v, ProvidedExpr.Create ctxt e1, ProvidedExpr.Create ctxt e2, ProvidedExpr.Create ctxt e3))
        | Patterns.VarSet(v, e) ->
            Some (ProvidedVarSetExpr (ProvidedVar.Create ctxt v, ProvidedExpr.Create ctxt e))
        | Patterns.IfThenElse(g, t, e) ->
            Some (ProvidedIfThenElseExpr (ProvidedExpr.Create ctxt g, ProvidedExpr.Create ctxt t, ProvidedExpr.Create ctxt e))
        | Patterns.Var v ->
            Some (ProvidedVarExpr (ProvidedVar.Create ctxt v))
        | _ -> None

    static member Create ctxt t = match box t with null -> null | _ -> ProvidedExpr (t, ctxt)

    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedExpr.Create ctxt)

    override _.Equals y = match y with :? ProvidedExpr as y -> x.Equals y.Handle | _ -> false

    override _.GetHashCode() = x.GetHashCode()

[<RequireQualifiedAccess; Class; AllowNullLiteral; Sealed>]
type ProvidedVar (x: Var, ctxt) =
    member _.Type = x.Type |> ProvidedType.Create ctxt
    member _.Name = x.Name
    member _.IsMutable = x.IsMutable
    member _.Handle = x
    member _.Context = ctxt
    static member Create ctxt t = match box t with null -> null | _ -> ProvidedVar (t, ctxt)
    static member CreateArray ctxt xs = match xs with null -> null | _ -> xs |> Array.map (ProvidedVar.Create ctxt)
    override _.Equals y = match y with :? ProvidedVar as y -> x.Equals y.Handle | _ -> false
    override _.GetHashCode() = x.GetHashCode()

/// Get the provided invoker expression for a particular use of a method.
let GetInvokerExpression (provider: ITypeProvider, methodBase: ProvidedMethodBase, paramExprs: ProvidedVar[]) = 
    provider.GetInvokerExpression(methodBase.Handle, [| for p in paramExprs -> Expr.Var p.Handle |]) |> ProvidedExpr.Create methodBase.Context

/// Compute the Name or FullName property of a provided type, reporting appropriate errors
let CheckAndComputeProvidedNameProperty(m, st: Tainted<ProvidedType>, proj, propertyString) =
    let name = 
        try st.PUntaint(proj, m) 
        with :? TypeProviderError as tpe -> 
            let newError = tpe.MapText((fun msg -> FSComp.SR.etProvidedTypeWithNameException(propertyString, msg)), st.TypeProviderDesignation, m)
            raise newError
    if String.IsNullOrEmpty name then
        raise (TypeProviderError(FSComp.SR.etProvidedTypeWithNullOrEmptyName propertyString, st.TypeProviderDesignation, m))
    name

/// Verify that this type provider has supported attributes
let ValidateAttributesOfProvidedType (m, st: Tainted<ProvidedType>) =         
    let fullName = CheckAndComputeProvidedNameProperty(m, st, (fun st -> st.FullName), "FullName")
    if TryTypeMember(st, fullName, "IsGenericType", m, false, fun st->st.IsGenericType) |> unmarshal then  
        errorR(Error(FSComp.SR.etMustNotBeGeneric fullName, m))  
    if TryTypeMember(st, fullName, "IsArray", m, false, fun st->st.IsArray) |> unmarshal then 
        errorR(Error(FSComp.SR.etMustNotBeAnArray fullName, m))  
    TryTypeMemberNonNull(st, fullName, "GetInterfaces", m, [||], fun st -> st.GetInterfaces()) |> ignore


/// Verify that a provided type has the expected name
let ValidateExpectedName m expectedPath expectedName (st: Tainted<ProvidedType>) =
    let name = CheckAndComputeProvidedNameProperty(m, st, (fun st -> st.Name), "Name")
    if name <> expectedName then
        raise (TypeProviderError(FSComp.SR.etProvidedTypeHasUnexpectedName(expectedName, name), st.TypeProviderDesignation, m))

    let namespaceName = TryTypeMember(st, name, "Namespace", m, "", fun st -> st.Namespace) |> unmarshal

    let rec declaringTypes (st: Tainted<ProvidedType>) accu =
        match TryTypeMember(st, name, "DeclaringType", m, null, fun st -> st.DeclaringType) with
        | Tainted.Null -> accu
        | dt -> declaringTypes dt (CheckAndComputeProvidedNameProperty(m, dt, (fun dt -> dt.Name), "Name") :: accu)

    let path = 
        [| match namespaceName with 
           | null -> ()
           | _ -> yield! namespaceName.Split([|'.'|])
           yield! declaringTypes st [] |]
        
    if path <> expectedPath then
        let expectedPath = String.Join(".", expectedPath)
        let path = String.Join(".", path)
        errorR(Error(FSComp.SR.etProvidedTypeHasUnexpectedPath(expectedPath, path), m))

/// Eagerly validate a range of conditions on a provided type, after static instantiation (if any) has occurred
let ValidateProvidedTypeAfterStaticInstantiation(m, st: Tainted<ProvidedType>, expectedPath: string[], expectedName: string) = 
    // Do all the calling into st up front with recovery
    let fullName, namespaceName, usedMembers =
        let name = CheckAndComputeProvidedNameProperty(m, st, (fun st -> st.Name), "Name")
        let namespaceName = TryTypeMember(st, name, "Namespace", m, FSComp.SR.invalidNamespaceForProvidedType(), fun st -> st.Namespace) |> unmarshal
        let fullName = TryTypeMemberNonNull(st, name, "FullName", m, FSComp.SR.invalidFullNameForProvidedType(), fun st -> st.FullName) |> unmarshal
        ValidateExpectedName m expectedPath expectedName st
        // Must be able to call (GetMethods|GetEvents|GetProperties|GetNestedTypes|GetConstructors)(bindingFlags).
        let usedMembers: Tainted<ProvidedMemberInfo>[] = 
            // These are the members the compiler will actually use
            [| for x in TryTypeMemberArray(st, fullName, "GetMethods", m, fun st -> st.GetMethods()) -> x.Coerce m
               for x in TryTypeMemberArray(st, fullName, "GetEvents", m, fun st -> st.GetEvents()) -> x.Coerce m
               for x in TryTypeMemberArray(st, fullName, "GetFields", m, fun st -> st.GetFields()) -> x.Coerce m
               for x in TryTypeMemberArray(st, fullName, "GetProperties", m, fun st -> st.GetProperties()) -> x.Coerce m
               // These will be validated on-demand
               //for x in TryTypeMemberArray(st, fullName, "GetNestedTypes", m, fun st -> st.GetNestedTypes bindingFlags) -> x.Coerce()
               for x in TryTypeMemberArray(st, fullName, "GetConstructors", m, fun st -> st.GetConstructors()) -> x.Coerce m |]
        fullName, namespaceName, usedMembers       

    // We scrutinize namespaces for invalid characters on open, but this provides better diagnostics
    ValidateNamespaceName(fullName, st.TypeProvider, m, namespaceName)

    ValidateAttributesOfProvidedType(m, st)

    // Those members must have this type.
    // This needs to be a *shallow* exploration. Otherwise, as in Freebase sample the entire database could be explored.
    for mi in usedMembers do
        match mi with 
        | Tainted.Null -> errorR(Error(FSComp.SR.etNullMember fullName, m))  
        | _ -> 
            let memberName = TryMemberMember(mi, fullName, "Name", "Name", m, "invalid provided type member name", fun mi -> mi.Name) |> unmarshal
            if String.IsNullOrEmpty memberName then 
                errorR(Error(FSComp.SR.etNullOrEmptyMemberName fullName, m))  
            else 
                let miDeclaringType = TryMemberMember(mi, fullName, memberName, "DeclaringType", m, ProvidedType.CreateNoContext(typeof<obj>), fun mi -> mi.DeclaringType)

                match miDeclaringType with 
                    // Generated nested types may have null DeclaringType
                | Tainted.Null when mi.OfType<ProvidedType>().IsSome -> ()
                | Tainted.Null -> 
                    errorR(Error(FSComp.SR.etNullMemberDeclaringType(fullName, memberName), m))   
                | _ ->     
                    let miDeclaringTypeFullName = 
                        TryMemberMember (miDeclaringType, fullName, memberName, "FullName", m,
                            "invalid declaring type full name",
                            fun miDeclaringType -> miDeclaringType.FullName)
                        |> unmarshal

                    if not (ProvidedType.TaintedEquals (st, miDeclaringType)) then 
                        errorR(Error(FSComp.SR.etNullMemberDeclaringTypeDifferentFromProvidedType(fullName, memberName, miDeclaringTypeFullName), m))   

                match mi.OfType<ProvidedMethodInfo>() with
                | Some mi ->
                    let isPublic = TryMemberMember(mi, fullName, memberName, "IsPublic", m, true, fun mi->mi.IsPublic) |> unmarshal
                    let isGenericMethod = TryMemberMember(mi, fullName, memberName, "IsGenericMethod", m, true, fun mi->mi.IsGenericMethod) |> unmarshal
                    if not isPublic || isGenericMethod then
                        errorR(Error(FSComp.SR.etMethodHasRequirements(fullName, memberName), m))   
                | None ->

                match mi.OfType<ProvidedType>() with
                | Some subType -> ValidateAttributesOfProvidedType(m, subType)
                | None ->

                match mi.OfType<ProvidedPropertyInfo>() with
                | Some pi ->
                    // Property must have a getter or setter
                    // TODO: Property must be public etc.
                    let expectRead =
                            match TryMemberMember(pi, fullName, memberName, "GetGetMethod", m, null, fun pi -> pi.GetGetMethod()) with 
                            | Tainted.Null -> false 
                            | _ -> true
                    let expectWrite = 
                        match TryMemberMember(pi, fullName, memberName, "GetSetMethod", m, null, fun pi-> pi.GetSetMethod()) with 
                        | Tainted.Null -> false 
                        | _ -> true
                    let canRead = TryMemberMember(pi, fullName, memberName, "CanRead", m, expectRead, fun pi-> pi.CanRead) |> unmarshal
                    let canWrite = TryMemberMember(pi, fullName, memberName, "CanWrite", m, expectWrite, fun pi-> pi.CanWrite) |> unmarshal
                    match expectRead, canRead with
                    | false, false | true, true-> ()
                    | false, true -> errorR(Error(FSComp.SR.etPropertyCanReadButHasNoGetter(memberName, fullName), m))   
                    | true, false -> errorR(Error(FSComp.SR.etPropertyHasGetterButNoCanRead(memberName, fullName), m))   
                    match expectWrite, canWrite with
                    | false, false | true, true-> ()
                    | false, true -> errorR(Error(FSComp.SR.etPropertyCanWriteButHasNoSetter(memberName, fullName), m))   
                    | true, false -> errorR(Error(FSComp.SR.etPropertyHasSetterButNoCanWrite(memberName, fullName), m))   
                    if not canRead && not canWrite then 
                        errorR(Error(FSComp.SR.etPropertyNeedsCanWriteOrCanRead(memberName, fullName), m))   
                | None ->

                match mi.OfType<ProvidedEventInfo>() with 
                | Some ei ->
                    // Event must have adder and remover
                    // TODO: Event must be public etc.
                    let adder = TryMemberMember(ei, fullName, memberName, "GetAddMethod", m, null, fun ei-> ei.GetAddMethod())
                    let remover = TryMemberMember(ei, fullName, memberName, "GetRemoveMethod", m, null, fun ei-> ei.GetRemoveMethod())
                    match adder, remover with
                    | Tainted.Null, _ -> errorR(Error(FSComp.SR.etEventNoAdd(memberName, fullName), m))   
                    | _, Tainted.Null -> errorR(Error(FSComp.SR.etEventNoRemove(memberName, fullName), m))   
                    | _, _ -> ()
                | None ->

                match mi.OfType<ProvidedConstructorInfo>() with
                | Some _  -> () // TODO: Constructors must be public etc.
                | None ->

                match mi.OfType<ProvidedFieldInfo>() with
                | Some _ -> () // TODO: Fields must be public, literals must have a value etc.
                | None ->
                    errorR(Error(FSComp.SR.etUnsupportedMemberKind(memberName, fullName), m))   

let ValidateProvidedTypeDefinition(m, st: Tainted<ProvidedType>, expectedPath: string[], expectedName: string) = 

    // Validate the Name, Namespace and FullName properties
    let name = CheckAndComputeProvidedNameProperty(m, st, (fun st -> st.Name), "Name")
    let _namespaceName = TryTypeMember(st, name, "Namespace", m, FSComp.SR.invalidNamespaceForProvidedType(), fun st -> st.Namespace) |> unmarshal
    let _fullname = TryTypeMemberNonNull(st, name, "FullName", m, FSComp.SR.invalidFullNameForProvidedType(), fun st -> st.FullName)  |> unmarshal
    ValidateExpectedName m expectedPath expectedName st

    ValidateAttributesOfProvidedType(m, st)

    // This excludes, for example, types with '.' in them which would not be resolvable during name resolution.
    match expectedName.IndexOfAny(PrettyNaming.IllegalCharactersInTypeAndNamespaceNames) with
    | -1 -> ()
    | n -> errorR(Error(FSComp.SR.etIllegalCharactersInTypeName(string expectedName[n], expectedName), m))  

    let staticParameters = st.PApplyWithProvider((fun (st, provider) -> st.GetStaticParameters provider), range=m) 
    if staticParameters.PUntaint((fun a -> a.Length), m)  = 0 then 
        ValidateProvidedTypeAfterStaticInstantiation(m, st, expectedPath, expectedName)


/// Resolve a (non-nested) provided type given a full namespace name and a type name. 
/// May throw an exception which will be turned into an error message by one of the 'Try' function below.
/// If resolution is successful the type is then validated.
let ResolveProvidedType (resolver: Tainted<ITypeProvider>, m, moduleOrNamespace: string[], typeName) =
    let displayName = String.Join(".", moduleOrNamespace)

    // Try to find the type in the given provided namespace
    let rec tryNamespace (providedNamespace: Tainted<IProvidedNamespace>) = 

        // Get the provided namespace name
        let providedNamespaceName = providedNamespace.PUntaint((fun providedNamespace -> providedNamespace.NamespaceName), range=m)

        // Check if the provided namespace name is an exact match of the required namespace name
        if displayName = providedNamespaceName then
            let resolvedType = providedNamespace.PApply((fun providedNamespace -> ProvidedType.CreateNoContext(providedNamespace.ResolveTypeName typeName)), range=m) 
            match resolvedType with
            | Tainted.Null -> None
            | Tainted.NonNull result -> 
                ValidateProvidedTypeDefinition(m, result, moduleOrNamespace, typeName)
                Some result
        else
            // Note: This eagerly explores all provided namespaces even if there is no match of even a prefix in the
            // namespace names. 
            let providedNamespaces = providedNamespace.PApplyArray((fun providedNamespace -> providedNamespace.GetNestedNamespaces()), "GetNestedNamespaces", range=m)
            tryNamespaces providedNamespaces

    and tryNamespaces (providedNamespaces: Tainted<IProvidedNamespace>[]) = 
        providedNamespaces |> Array.tryPick tryNamespace

    let providedNamespaces = resolver.PApplyArray((fun resolver -> resolver.GetNamespaces()), "GetNamespaces", range=m)
    match tryNamespaces providedNamespaces with 
    | None -> resolver.PApply((fun _ -> null), m)
    | Some res -> res
                    
/// Try to resolve a type against the given host with the given resolution environment.
let TryResolveProvidedType(resolver: Tainted<ITypeProvider>, m, moduleOrNamespace, typeName) =
    try 
        match ResolveProvidedType(resolver, m, moduleOrNamespace, typeName) with
        | Tainted.Null -> None
        | Tainted.NonNull ty -> Some ty
    with RecoverableException e -> 
        errorRecovery e m
        None

let ILPathToProvidedType  (st: Tainted<ProvidedType>, m) = 
    let nameContrib (st: Tainted<ProvidedType>) = 
        let typeName = st.PUntaint((fun st -> st.Name), m)
        match st.PApply((fun st -> st.DeclaringType), m) with 
        | Tainted.Null -> 
            match st.PUntaint((fun st -> st.Namespace), m) with 
            | Null  -> typeName
            | NonNull ns -> ns + "." + typeName
        | _ -> typeName

    let rec encContrib (st: Tainted<ProvidedType>) = 
        match st.PApply((fun st ->st.DeclaringType), m) with 
        | Tainted.Null -> []
        | enc -> encContrib enc @ [ nameContrib enc ]

    encContrib st, nameContrib st

let ComputeMangledNameForApplyStaticParameters(nm, staticArgs, staticParams: Tainted<ProvidedParameterInfo[]>, m) =
    let defaultArgValues = 
        staticParams.PApply((fun ps ->  ps |> Array.map (fun sp -> sp.Name, (if sp.IsOptional then Some (string sp.RawDefaultValue) else None ))), range=m)

    let defaultArgValues = defaultArgValues.PUntaint(id, m)
    PrettyNaming.ComputeMangledNameWithoutDefaultArgValues(nm, staticArgs, defaultArgValues)

/// Apply the given provided method to the given static arguments (the arguments are assumed to have been sorted into application order)
let TryApplyProvidedMethod(methBeforeArgs: Tainted<ProvidedMethodBase>, staticArgs: obj[], m: range) =
    if staticArgs.Length = 0 then 
        Some methBeforeArgs
    else
        let mangledName = 
            let nm = methBeforeArgs.PUntaint((fun x -> x.Name), m)
            let staticParams = methBeforeArgs.PApplyWithProvider((fun (mb, resolver) -> mb.GetStaticParametersForMethod resolver), range=m) 
            let mangledName = ComputeMangledNameForApplyStaticParameters(nm, staticArgs, staticParams, m)
            mangledName
 
        match methBeforeArgs.PApplyWithProvider((fun (mb, provider) -> mb.ApplyStaticArgumentsForMethod(provider, mangledName, staticArgs)), range=m) with 
        | Tainted.Null -> None
        | Tainted.NonNull methWithArguments -> 
            let actualName = methWithArguments.PUntaint((fun x -> x.Name), m)
            if actualName <> mangledName then 
                error(Error(FSComp.SR.etProvidedAppliedMethodHadWrongName(methWithArguments.TypeProviderDesignation, mangledName, actualName), m))
            Some methWithArguments


/// Apply the given provided type to the given static arguments (the arguments are assumed to have been sorted into application order
let TryApplyProvidedType(typeBeforeArguments: Tainted<ProvidedType>, optGeneratedTypePath: string list option, staticArgs: obj[], m: range) =
    if staticArgs.Length = 0 then 
        Some (typeBeforeArguments, (fun () -> ()))
    else 
            
        let fullTypePathAfterArguments = 
            // If there is a generated type name, then use that
            match optGeneratedTypePath with 
            | Some path -> path
            | None -> 
                // Otherwise, use the full path of the erased type, including mangled arguments
                let nm = typeBeforeArguments.PUntaint((fun x -> x.Name), m)
                let enc, _ = ILPathToProvidedType (typeBeforeArguments, m)
                let staticParams = typeBeforeArguments.PApplyWithProvider((fun (mb, resolver) -> mb.GetStaticParameters resolver), range=m) 
                let mangledName = ComputeMangledNameForApplyStaticParameters(nm, staticArgs, staticParams, m)
                enc @ [ mangledName ]
 
        match typeBeforeArguments.PApplyWithProvider((fun (typeBeforeArguments, provider) -> typeBeforeArguments.ApplyStaticArguments(provider, Array.ofList fullTypePathAfterArguments, staticArgs)), range=m) with 
        | Tainted.Null -> None
        | Tainted.NonNull typeWithArguments -> 
            let actualName = typeWithArguments.PUntaint((fun x -> x.Name), m)
            let checkTypeName() = 
                let expectedTypeNameAfterArguments = fullTypePathAfterArguments[fullTypePathAfterArguments.Length-1]
                if actualName <> expectedTypeNameAfterArguments then 
                    error(Error(FSComp.SR.etProvidedAppliedTypeHadWrongName(typeWithArguments.TypeProviderDesignation, expectedTypeNameAfterArguments, actualName), m))
            Some (typeWithArguments, checkTypeName)

/// Given a mangled name reference to a non-nested provided type, resolve it.
/// If necessary, demangle its static arguments before applying them.
let TryLinkProvidedType(resolver: Tainted<ITypeProvider>, moduleOrNamespace: string[], typeLogicalName: string, range: range) =
        
    // Demangle the static parameters
    let typeName, argNamesAndValues = 
        try 
            PrettyNaming.DemangleProvidedTypeName typeLogicalName 
        with PrettyNaming.InvalidMangledStaticArg piece -> 
            error(Error(FSComp.SR.etProvidedTypeReferenceInvalidText piece, range0)) 

    let argSpecsTable = dict argNamesAndValues
    let typeBeforeArguments = ResolveProvidedType(resolver, range0, moduleOrNamespace, typeName) 

    match typeBeforeArguments with 
    | Tainted.Null -> None
    | _ -> 
        // Take the static arguments (as strings, taken from the text in the reference we're relinking), 
        // and convert them to objects of the appropriate type, based on the expected kind.
        let staticParameters =
            typeBeforeArguments.PApplyWithProvider((fun (typeBeforeArguments, resolver) ->
                typeBeforeArguments.GetStaticParameters resolver),range=range0)

        let staticParameters = staticParameters.PApplyArray(id, "", range)
            
        let staticArgs = 
            staticParameters |> Array.map (fun sp -> 
                let typeBeforeArgumentsName = typeBeforeArguments.PUntaint ((fun st -> st.Name), range)
                let spName = sp.PUntaint ((fun sp -> sp.Name), range)
                match argSpecsTable.TryGetValue spName with
                | true, arg ->
                    /// Find the name of the representation type for the static parameter
                    let spReprTypeName = 
                        sp.PUntaint((fun sp -> 
                            let pt = sp.ParameterType
                            let uet = if pt.IsEnum then pt.GetEnumUnderlyingType() else pt
                            uet.FullName), range)

                    match spReprTypeName with 
                    | "System.SByte" -> box (sbyte arg)
                    | "System.Int16" -> box (int16 arg)
                    | "System.Int32" -> box (int32 arg)
                    | "System.Int64" -> box (int64 arg)
                    | "System.Byte" -> box (byte arg)
                    | "System.UInt16" -> box (uint16 arg)
                    | "System.UInt32" -> box (uint32 arg)
                    | "System.UInt64" -> box (uint64 arg)
                    | "System.Decimal" -> box (decimal arg)
                    | "System.Single" -> box (single arg)
                    | "System.Double" -> box (double arg)
                    | "System.Char" -> box (char arg)
                    | "System.Boolean" -> box (arg = "True")
                    | "System.String" -> box (string arg)
                    | s -> error(Error(FSComp.SR.etUnknownStaticArgumentKind(s, typeLogicalName), range0))

                | _ ->
                    if sp.PUntaint ((fun sp -> sp.IsOptional), range) then 
                        match sp.PUntaint((fun sp -> sp.RawDefaultValue), range) with
                        | Null -> error (Error(FSComp.SR.etStaticParameterRequiresAValue (spName, typeBeforeArgumentsName, typeBeforeArgumentsName, spName), range0))
                        | NonNull v -> v
                    else
                        error(Error(FSComp.SR.etProvidedTypeReferenceMissingArgument spName, range0)))
                    

        match TryApplyProvidedType(typeBeforeArguments, None, staticArgs, range0) with 
        | Some (typeWithArguments, checkTypeName) -> 
            checkTypeName() 
            Some typeWithArguments
        | None -> None

/// Get the parts of a .NET namespace. Special rules: null means global, empty is not allowed.
let GetPartsOfNamespaceRecover(namespaceName: string) = 
    match namespaceName with 
    | Null -> [] 
    | NonNull namespaceName -> 
        if namespaceName.Length = 0 then ["<NonExistentNamespace>"]
        else splitNamespace (nonNull namespaceName)

/// Get the parts of a .NET namespace. Special rules: null means global, empty is not allowed.
let GetProvidedNamespaceAsPath (m, resolver: Tainted<ITypeProvider>, namespaceName: string) = 
    match namespaceName with 
    | Null -> [] 
    | NonNull namespaceName -> 
        if namespaceName.Length = 0 then
            errorR(Error(FSComp.SR.etEmptyNamespaceNotAllowed(DisplayNameOfTypeProvider(resolver.TypeProvider, m)), m))  
        GetPartsOfNamespaceRecover namespaceName

/// Get the parts of the name that encloses the .NET type including nested types. 
let GetFSharpPathToProvidedType (st: Tainted<ProvidedType>, range) = 
    // Can't use st.Fullname because it may be like IEnumerable<Something>
    // We want [System;Collections;Generic]
    let namespaceParts = GetPartsOfNamespaceRecover(st.PUntaint((fun st -> st.Namespace), range))
    let rec walkUpNestedClasses(st: Tainted<ProvidedType>, soFar) =
        match st with
        | Tainted.Null -> soFar
        | Tainted.NonNull st -> walkUpNestedClasses(st.PApply((fun st ->st.DeclaringType), range), soFar) @ [st.PUntaint((fun st -> st.Name), range)]

    walkUpNestedClasses(st.PApply((fun st ->st.DeclaringType), range), namespaceParts)


/// Get the ILAssemblyRef for a provided assembly. Do not take into account
/// any type relocations or static linking for generated types.
let GetOriginalILAssemblyRefOfProvidedAssembly (assembly: Tainted<ProvidedAssembly>, m) =
    let aname = assembly.PUntaint((fun assembly -> assembly.GetName()), m)
    ILAssemblyRef.FromAssemblyName aname

/// Get the ILTypeRef for the provided type (including for nested types). Do not take into account
/// any type relocations or static linking for generated types.
let GetOriginalILTypeRefOfProvidedType (st: Tainted<ProvidedType>, range) = 
        
    let aref = GetOriginalILAssemblyRefOfProvidedAssembly (st.PApply((fun st -> st.Assembly), range), range)
    let scoperef = ILScopeRef.Assembly aref
    let enc, nm = ILPathToProvidedType (st, range)
    let tref = ILTypeRef.Create(scoperef, enc, nm)
    tref

/// Get the ILTypeRef for the provided type (including for nested types). Take into account
/// any type relocations or static linking for generated types.
let GetILTypeRefOfProvidedType (st: Tainted<ProvidedType>, range) = 
    match st.PUntaint((fun st -> st.TryGetILTypeRef()), range) with 
    | Some ilTypeRef -> ilTypeRef
    | None -> GetOriginalILTypeRefOfProvidedType (st, range)

type ProviderGeneratedType = ProviderGeneratedType of ilOrigTyRef: ILTypeRef * ilRenamedTyRef: ILTypeRef * ProviderGeneratedType list

/// The table of information recording remappings from type names in the provided assembly to type
/// names in the statically linked, embedded assembly, plus what types are nested in side what types.
type ProvidedAssemblyStaticLinkingMap = 
    { ILTypeMap: Dictionary<ILTypeRef, ILTypeRef> }

    static member CreateNew() = 
        { ILTypeMap = Dictionary() }

/// Check if this is a direct reference to a non-embedded generated type. This is not permitted at any name resolution.
/// We check by seeing if the type is absent from the remapping context.
let IsGeneratedTypeDirectReference (st: Tainted<ProvidedType>, m) =
    st.PUntaint((fun st -> st.TryGetTyconRef() |> Option.isNone), m)

#endif
