{-# LANGUAGE CPP #-}
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NondecreasingIndentation #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE MultiWayIf #-}
{-# LANGUAGE TupleSections #-}

{-# OPTIONS_GHC -Wno-incomplete-record-updates #-}

{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998

-}

-- | Typechecking a whole module
--
-- https://gitlab.haskell.org/ghc/ghc/wikis/commentary/compiler/type-checker
module GHC.Tc.Module (
        tcRnStmt, tcRnExpr, TcRnExprMode(..), tcRnType,
        tcRnImportDecls,
        tcRnLookupRdrName,
        getModuleInterface,
        tcRnDeclsi,
        isGHCiMonad,
        runTcInteractive,    -- Used by GHC API clients (#8878)
        withTcPlugins,       -- Used by GHC API clients (#20499)
        withHoleFitPlugins,  -- Used by GHC API clients (#20499)
        tcRnLookupName,
        tcRnGetInfo,
        tcRnModule, tcRnModuleTcRnM,
        tcTopSrcDecls,
        rnTopSrcDecls,
        checkBootDecl, checkHiBootIface',
        findExtraSigImports,
        implicitRequirements,
        checkUnit,
        mergeSignatures,
        tcRnMergeSignatures,
        instantiateSignature,
        tcRnInstantiateSignature,
        loadUnqualIfaces,
        -- More private...
        checkBootDeclM,
        getRenamedStuff, RenamedStuff
    ) where

import GHC.Prelude

import GHC.Driver.Env
import GHC.Driver.Plugins
import GHC.Driver.DynFlags
import GHC.Driver.Config.Diagnostic

import GHC.Tc.Errors.Hole.Plugin ( HoleFitPluginR (..) )
import GHC.Tc.Errors.Types
import {-# SOURCE #-} GHC.Tc.Gen.Splice ( finishTH, runRemoteModFinalizers )
import GHC.Tc.Gen.HsType
import GHC.Tc.Validity( checkValidType )
import GHC.Tc.Gen.Match
import GHC.Tc.Utils.Unify( checkConstraints, tcSubTypeSigma )
import GHC.Tc.Zonk.Type
import GHC.Tc.Gen.Expr
import GHC.Tc.Gen.App( tcInferSigma )
import GHC.Tc.Utils.Monad
import GHC.Tc.Gen.Export
import GHC.Tc.Types.Evidence
import GHC.Tc.Types.Constraint
import GHC.Tc.Types.Origin
import GHC.Tc.Instance.Family
import GHC.Tc.Gen.Annotation
import GHC.Tc.Gen.Bind
import GHC.Tc.Gen.Default
import GHC.Tc.Utils.Env
import GHC.Tc.Gen.Rule
import GHC.Tc.Gen.Foreign
import GHC.Tc.TyCl.Instance
import GHC.Tc.Utils.TcMType
import GHC.Tc.Utils.TcType
import GHC.Tc.Solver
import GHC.Tc.TyCl
import GHC.Tc.Instance.Typeable ( mkTypeableBinds )
import GHC.Tc.Utils.Backpack
import GHC.Tc.Zonk.TcType

import GHC.Rename.Bind ( rejectBootDecls )
import GHC.Rename.Splice ( rnTopSpliceDecls, traceSplice, SpliceInfo(..) )
import GHC.Rename.HsType
import GHC.Rename.Expr
import GHC.Rename.Fixity ( lookupFixityRn )
import GHC.Rename.Names
import GHC.Rename.Env
import GHC.Rename.Module
import GHC.Rename.Doc
import GHC.Rename.Utils ( mkNameClashErr )

import GHC.Iface.Decl    ( coAxiomToIfaceDecl )
import GHC.Iface.Env     ( externaliseName )
import GHC.Iface.Load

import GHC.Builtin.Types ( mkListTy, anyTypeOfKind )
import GHC.Builtin.Names
import GHC.Builtin.Utils

import GHC.Hs hiding ( FunDep(..) )
import GHC.Hs.Dump

import GHC.Core.PatSyn
import GHC.Core.Predicate ( classMethodTy )
import GHC.Core.InstEnv
import GHC.Core.TyCon
import GHC.Core.DataCon
import GHC.Core.TyCo.Rep
import GHC.Core.Type
import GHC.Core.Class
import GHC.Core.Coercion.Axiom
import GHC.Core.Reduction ( Reduction(..) )
import GHC.Core.TyCo.Ppr( debugPprType )
import GHC.Core.FamInstEnv
   ( FamInst, pprFamInst, famInstsRepTyCons, orphNamesOfFamInst
   , famInstEnvElts, extendFamInstEnvList, normaliseType )

import GHC.Parser.Header       ( mkPrelImports )

import GHC.IfaceToCore

import GHC.Runtime.Context

import GHC.Utils.Error
import GHC.Utils.Outputable as Outputable
import GHC.Utils.Panic
import GHC.Utils.Panic.Plain
import GHC.Utils.Misc
import GHC.Utils.Logger

import GHC.Types.Error
import GHC.Types.Name.Reader
import GHC.Types.Fixity.Env
import GHC.Types.Id as Id
import GHC.Types.Id.Info( IdDetails(..) )
import GHC.Types.Var.Env
import GHC.Types.TypeEnv
import GHC.Types.Unique.FM
import GHC.Types.Name
import GHC.Types.Name.Env
import GHC.Types.Name.Set
import GHC.Types.Avail
import GHC.Types.Basic hiding( SuccessFlag(..) )
import GHC.Types.Annotations
import GHC.Types.SrcLoc
import GHC.Types.SourceFile
import GHC.Types.PkgQual
import qualified GHC.LanguageExtensions as LangExt

import GHC.Unit.External
import GHC.Unit.Types
import GHC.Unit.State
import GHC.Unit.Home
import GHC.Unit.Module
import GHC.Unit.Module.Warnings
import GHC.Unit.Module.ModSummary
import GHC.Unit.Module.ModIface
import GHC.Unit.Module.ModDetails
import GHC.Unit.Module.Deps

import GHC.Data.FastString
import GHC.Data.Maybe
import GHC.Data.List.SetOps
import GHC.Data.Bag
import qualified GHC.Data.BooleanFormula as BF

import Control.Arrow ( second )
import Control.DeepSeq
import Control.Monad
import Control.Monad.Trans.Writer.CPS
import Data.Data ( Data )
import Data.Functor.Classes ( liftEq )
import Data.List ( sortBy, sort )
import Data.List.NonEmpty ( NonEmpty (..) )
import qualified Data.List.NonEmpty as NE
import Data.Ord
import qualified Data.Set as S
import Data.Foldable ( for_ )
import Data.Traversable ( for )



{-
************************************************************************
*                                                                      *
        Typecheck and rename a module
*                                                                      *
************************************************************************
-}

-- | Top level entry point for typechecker and renamer
tcRnModule :: HscEnv
           -> ModSummary
           -> Bool              -- True <=> save renamed syntax
           -> HsParsedModule
           -> IO (Messages TcRnMessage, Maybe TcGblEnv)

tcRnModule :: HscEnv
-> ModSummary
-> Bool
-> HsParsedModule
-> IO (Messages TcRnMessage, Maybe TcGblEnv)
tcRnModule HscEnv
hsc_env ModSummary
mod_sum Bool
save_rn_syntax
   parsedModule :: HsParsedModule
parsedModule@HsParsedModule {hpm_module :: HsParsedModule -> Located (HsModule GhcPs)
hpm_module= L SrcSpan
loc HsModule GhcPs
this_module}
 | RealSrcSpan RealSrcSpan
real_loc Maybe BufSpan
_ <- SrcSpan
loc
 = Logger
-> SDoc
-> ((Messages TcRnMessage, Maybe TcGblEnv) -> ())
-> IO (Messages TcRnMessage, Maybe TcGblEnv)
-> IO (Messages TcRnMessage, Maybe TcGblEnv)
forall (m :: * -> *) a.
MonadIO m =>
Logger -> SDoc -> (a -> ()) -> m a -> m a
withTiming Logger
logger
              (String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"Renamer/typechecker"SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+>SDoc -> SDoc
forall doc. IsLine doc => doc -> doc
brackets (Module -> SDoc
forall a. Outputable a => a -> SDoc
ppr Module
this_mod))
              (() -> (Messages TcRnMessage, Maybe TcGblEnv) -> ()
forall a b. a -> b -> a
const ()) (IO (Messages TcRnMessage, Maybe TcGblEnv)
 -> IO (Messages TcRnMessage, Maybe TcGblEnv))
-> IO (Messages TcRnMessage, Maybe TcGblEnv)
-> IO (Messages TcRnMessage, Maybe TcGblEnv)
forall a b. (a -> b) -> a -> b
$
   HscEnv
-> HscSource
-> Bool
-> Module
-> RealSrcSpan
-> TcM TcGblEnv
-> IO (Messages TcRnMessage, Maybe TcGblEnv)
forall r.
HscEnv
-> HscSource
-> Bool
-> Module
-> RealSrcSpan
-> TcM r
-> IO (Messages TcRnMessage, Maybe r)
initTc HscEnv
hsc_env HscSource
hsc_src Bool
save_rn_syntax Module
this_mod RealSrcSpan
real_loc (TcM TcGblEnv -> IO (Messages TcRnMessage, Maybe TcGblEnv))
-> TcM TcGblEnv -> IO (Messages TcRnMessage, Maybe TcGblEnv)
forall a b. (a -> b) -> a -> b
$
          HscEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall a. HscEnv -> TcM a -> TcM a
withTcPlugins HscEnv
hsc_env (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$
          HscEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall a. HscEnv -> TcM a -> TcM a
withDefaultingPlugins HscEnv
hsc_env (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$
          HscEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall a. HscEnv -> TcM a -> TcM a
withHoleFitPlugins HscEnv
hsc_env (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$

          HscEnv
-> ModSummary
-> HsParsedModule
-> (Module, SrcSpan)
-> TcM TcGblEnv
tcRnModuleTcRnM HscEnv
hsc_env ModSummary
mod_sum HsParsedModule
parsedModule (Module, SrcSpan)
pair

  | Bool
otherwise
  = (Messages TcRnMessage, Maybe TcGblEnv)
-> IO (Messages TcRnMessage, Maybe TcGblEnv)
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return (MsgEnvelope TcRnMessage
err_msg MsgEnvelope TcRnMessage
-> Messages TcRnMessage -> Messages TcRnMessage
forall e. MsgEnvelope e -> Messages e -> Messages e
`addMessage` Messages TcRnMessage
forall e. Messages e
emptyMessages, Maybe TcGblEnv
forall a. Maybe a
Nothing)

  where
    hsc_src :: HscSource
hsc_src = ModSummary -> HscSource
ms_hsc_src ModSummary
mod_sum
    logger :: Logger
logger  = HscEnv -> Logger
hsc_logger HscEnv
hsc_env
    home_unit :: HomeUnit
home_unit = HscEnv -> HomeUnit
hsc_home_unit HscEnv
hsc_env
    err_msg :: MsgEnvelope TcRnMessage
err_msg = SrcSpan -> TcRnMessage -> MsgEnvelope TcRnMessage
forall e. Diagnostic e => SrcSpan -> e -> MsgEnvelope e
mkPlainErrorMsgEnvelope SrcSpan
loc (TcRnMessage -> MsgEnvelope TcRnMessage)
-> TcRnMessage -> MsgEnvelope TcRnMessage
forall a b. (a -> b) -> a -> b
$
              Module -> TcRnMessage
TcRnModMissingRealSrcSpan Module
this_mod

    pair :: (Module, SrcSpan)
    pair :: (Module, SrcSpan)
pair@(Module
this_mod,SrcSpan
_)
      | Just (L SrcSpanAnnA
mod_loc ModuleName
mod) <- HsModule GhcPs -> Maybe (XRec GhcPs ModuleName)
forall p. HsModule p -> Maybe (XRec p ModuleName)
hsmodName HsModule GhcPs
this_module
      = (HomeUnit -> ModuleName -> Module
mkHomeModule HomeUnit
home_unit ModuleName
mod, SrcSpanAnnA -> SrcSpan
forall a. SrcSpanAnn' a -> SrcSpan
locA SrcSpanAnnA
mod_loc)

      | Bool
otherwise   -- 'module M where' is omitted
      = (HomeUnit -> ModuleName -> Module
mkHomeModule HomeUnit
home_unit ModuleName
mAIN_NAME, SrcLoc -> SrcSpan
srcLocSpan (SrcSpan -> SrcLoc
srcSpanStart SrcSpan
loc))




tcRnModuleTcRnM :: HscEnv
                -> ModSummary
                -> HsParsedModule
                -> (Module, SrcSpan)
                -> TcRn TcGblEnv
-- Factored out separately from tcRnModule so that a Core plugin can
-- call the type checker directly
tcRnModuleTcRnM :: HscEnv
-> ModSummary
-> HsParsedModule
-> (Module, SrcSpan)
-> TcM TcGblEnv
tcRnModuleTcRnM HscEnv
hsc_env ModSummary
mod_sum
                (HsParsedModule {
                   hpm_module :: HsParsedModule -> Located (HsModule GhcPs)
hpm_module =
                      (L SrcSpan
loc (HsModule (XModulePs EpAnn AnnsModule
_ LayoutInfo GhcPs
_ Maybe (LocatedP (WarningTxt GhcPs))
mod_deprec Maybe (LHsDoc GhcPs)
maybe_doc_hdr)
                                       Maybe (XRec GhcPs ModuleName)
maybe_mod Maybe (XRec GhcPs [XRec GhcPs (IE GhcPs)])
export_ies [LImportDecl GhcPs]
import_decls [LHsDecl GhcPs]
local_decls)),
                   hpm_src_files :: HsParsedModule -> [String]
hpm_src_files = [String]
src_files
                })
                (Module
this_mod, SrcSpan
prel_imp_loc)
 = SrcSpan -> TcM TcGblEnv -> TcM TcGblEnv
forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan SrcSpan
loc (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$
   do { let { explicit_mod_hdr :: Bool
explicit_mod_hdr = Maybe (GenLocated SrcSpanAnnA ModuleName) -> Bool
forall a. Maybe a -> Bool
isJust Maybe (XRec GhcPs ModuleName)
Maybe (GenLocated SrcSpanAnnA ModuleName)
maybe_mod
            ; hsc_src :: HscSource
hsc_src          = ModSummary -> HscSource
ms_hsc_src ModSummary
mod_sum }
      ; -- Load the hi-boot interface for this module, if any
        -- We do this now so that the boot_names can be passed
        -- to tcTyAndClassDecls, because the boot_names are
        -- automatically considered to be loop breakers
        TcGblEnv
tcg_env <- TcM TcGblEnv
forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
      ; SelfBootInfo
boot_info <- HscSource -> Module -> TcRn SelfBootInfo
tcHiBootIface HscSource
hsc_src Module
this_mod
      ; TcGblEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv (TcGblEnv
tcg_env { tcg_self_boot = boot_info })
        (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ do
        { -- Deal with imports; first add implicit prelude
          Bool
implicit_prelude <- Extension -> TcRnIf TcGblEnv TcLclEnv Bool
forall gbl lcl. Extension -> TcRnIf gbl lcl Bool
xoptM Extension
LangExt.ImplicitPrelude
        ; let { prel_imports :: [LImportDecl GhcPs]
prel_imports = ModuleName
-> SrcSpan -> Bool -> [LImportDecl GhcPs] -> [LImportDecl GhcPs]
mkPrelImports (Module -> ModuleName
forall unit. GenModule unit -> ModuleName
moduleName Module
this_mod) SrcSpan
prel_imp_loc
                               Bool
implicit_prelude [LImportDecl GhcPs]
import_decls }

        ; Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when ([GenLocated SrcSpanAnnA (ImportDecl GhcPs)] -> Bool
forall (f :: * -> *) a. Foldable f => f a -> Bool
notNull [LImportDecl GhcPs]
[GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
prel_imports) (IOEnv (Env TcGblEnv TcLclEnv) ()
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ do
            TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addDiagnostic TcRnMessage
TcRnImplicitImportOfPrelude

        ; -- TODO This is a little skeevy; maybe handle a bit more directly
          let { simplifyImport :: GenLocated SrcSpanAnnA (ImportDecl GhcPs)
-> (PkgQual, Located ModuleName)
simplifyImport (L SrcSpanAnnA
_ ImportDecl GhcPs
idecl) =
                  ( UnitEnv -> ModuleName -> RawPkgQual -> PkgQual
renameRawPkgQual (HscEnv -> UnitEnv
hsc_unit_env HscEnv
hsc_env) (GenLocated SrcSpanAnnA ModuleName -> ModuleName
forall l e. GenLocated l e -> e
unLoc (GenLocated SrcSpanAnnA ModuleName -> ModuleName)
-> GenLocated SrcSpanAnnA ModuleName -> ModuleName
forall a b. (a -> b) -> a -> b
$ ImportDecl GhcPs -> XRec GhcPs ModuleName
forall pass. ImportDecl pass -> XRec pass ModuleName
ideclName ImportDecl GhcPs
idecl) (ImportDecl GhcPs -> ImportDeclPkgQual GhcPs
forall pass. ImportDecl pass -> ImportDeclPkgQual pass
ideclPkgQual ImportDecl GhcPs
idecl)
                  , GenLocated SrcSpanAnnA ModuleName -> Located ModuleName
forall a e. LocatedAn a e -> Located e
reLoc (GenLocated SrcSpanAnnA ModuleName -> Located ModuleName)
-> GenLocated SrcSpanAnnA ModuleName -> Located ModuleName
forall a b. (a -> b) -> a -> b
$ ImportDecl GhcPs -> XRec GhcPs ModuleName
forall pass. ImportDecl pass -> XRec pass ModuleName
ideclName ImportDecl GhcPs
idecl)
              }
        ; [ModuleName]
raw_sig_imports <- IO [ModuleName] -> IOEnv (Env TcGblEnv TcLclEnv) [ModuleName]
forall a. IO a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO
                             (IO [ModuleName] -> IOEnv (Env TcGblEnv TcLclEnv) [ModuleName])
-> IO [ModuleName] -> IOEnv (Env TcGblEnv TcLclEnv) [ModuleName]
forall a b. (a -> b) -> a -> b
$ HscEnv -> HscSource -> ModuleName -> IO [ModuleName]
findExtraSigImports HscEnv
hsc_env HscSource
hsc_src
                                 (Module -> ModuleName
forall unit. GenModule unit -> ModuleName
moduleName Module
this_mod)
        ; [ModuleName]
raw_req_imports <- IO [ModuleName] -> IOEnv (Env TcGblEnv TcLclEnv) [ModuleName]
forall a. IO a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO
                             (IO [ModuleName] -> IOEnv (Env TcGblEnv TcLclEnv) [ModuleName])
-> IO [ModuleName] -> IOEnv (Env TcGblEnv TcLclEnv) [ModuleName]
forall a b. (a -> b) -> a -> b
$ HscEnv -> [(PkgQual, Located ModuleName)] -> IO [ModuleName]
implicitRequirements HscEnv
hsc_env
                                ((GenLocated SrcSpanAnnA (ImportDecl GhcPs)
 -> (PkgQual, Located ModuleName))
-> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
-> [(PkgQual, Located ModuleName)]
forall a b. (a -> b) -> [a] -> [b]
map GenLocated SrcSpanAnnA (ImportDecl GhcPs)
-> (PkgQual, Located ModuleName)
simplifyImport ([LImportDecl GhcPs]
[GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
prel_imports
                                                     [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
-> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
-> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
forall a. [a] -> [a] -> [a]
++ [LImportDecl GhcPs]
[GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
import_decls))
        ; let { mkImport :: ModuleName -> LocatedAn an (ImportDecl pass)
mkImport ModuleName
mod_name = ImportDecl pass -> LocatedAn an (ImportDecl pass)
forall a an. a -> LocatedAn an a
noLocA
                (ImportDecl pass -> LocatedAn an (ImportDecl pass))
-> ImportDecl pass -> LocatedAn an (ImportDecl pass)
forall a b. (a -> b) -> a -> b
$ (ModuleName -> ImportDecl GhcPs
simpleImportDecl ModuleName
mod_name)
                  { ideclImportList = Just (Exactly, noLocA [])}}
        ; let { withReason :: String -> [a] -> [(a, t)]
withReason String
t [a]
imps = (a -> (a, t)) -> [a] -> [(a, t)]
forall a b. (a -> b) -> [a] -> [b]
map (,String -> t
forall doc. IsLine doc => String -> doc
text String
t) [a]
imps }
        ; let { all_imports :: [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
all_imports = String
-> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
forall {t} {a}. IsLine t => String -> [a] -> [(a, t)]
withReason String
"is implicitly imported" [LImportDecl GhcPs]
[GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
prel_imports
                  [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
forall a. [a] -> [a] -> [a]
++ String
-> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
forall {t} {a}. IsLine t => String -> [a] -> [(a, t)]
withReason String
"is directly imported" [LImportDecl GhcPs]
[GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
import_decls
                  [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
forall a. [a] -> [a] -> [a]
++ String
-> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
forall {t} {a}. IsLine t => String -> [a] -> [(a, t)]
withReason String
"is an extra sig import" ((ModuleName -> GenLocated SrcSpanAnnA (ImportDecl GhcPs))
-> [ModuleName] -> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
forall a b. (a -> b) -> [a] -> [b]
map ModuleName -> GenLocated SrcSpanAnnA (ImportDecl GhcPs)
forall {pass} {an} {an}.
(XCImportDecl pass ~ XImportDeclPass,
 XRec pass [XRec pass (IE pass)]
 ~ LocatedAn an [XRec pass (IE pass)],
 XRec pass ModuleName ~ GenLocated SrcSpanAnnA ModuleName,
 ImportDeclPkgQual pass ~ RawPkgQual) =>
ModuleName -> LocatedAn an (ImportDecl pass)
mkImport [ModuleName]
raw_sig_imports)
                  [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
forall a. [a] -> [a] -> [a]
++ String
-> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
forall {t} {a}. IsLine t => String -> [a] -> [(a, t)]
withReason String
"is an implicit req import" ((ModuleName -> GenLocated SrcSpanAnnA (ImportDecl GhcPs))
-> [ModuleName] -> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
forall a b. (a -> b) -> [a] -> [b]
map ModuleName -> GenLocated SrcSpanAnnA (ImportDecl GhcPs)
forall {pass} {an} {an}.
(XCImportDecl pass ~ XImportDeclPass,
 XRec pass [XRec pass (IE pass)]
 ~ LocatedAn an [XRec pass (IE pass)],
 XRec pass ModuleName ~ GenLocated SrcSpanAnnA ModuleName,
 ImportDeclPkgQual pass ~ RawPkgQual) =>
ModuleName -> LocatedAn an (ImportDecl pass)
mkImport [ModuleName]
raw_req_imports) }
        ; -- OK now finally rename the imports
          TcGblEnv
tcg_env <- {-# SCC "tcRnImports" #-}
                     HscEnv -> [(LImportDecl GhcPs, SDoc)] -> TcM TcGblEnv
tcRnImports HscEnv
hsc_env [(LImportDecl GhcPs, SDoc)]
[(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
all_imports

        -- Put a version of the header without identifier info into the tcg_env
        -- Make sure to do this before 'tcRnSrcDecls', because we need the
        -- module header when we're splicing TH, since it can be accessed via
        -- 'getDoc'.
        -- We will rename it properly after renaming everything else so that
        -- haddock can link the identifiers
        ; TcGblEnv
tcg_env <- TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env
                              { tcg_doc_hdr = fmap (\(WithHsDocIdentifiers HsDocString
str [Located (IdP GhcPs)]
_) -> HsDocString
-> [Located (IdP (GhcPass 'Renamed))] -> HsDoc (GhcPass 'Renamed)
forall a pass.
a -> [Located (IdP pass)] -> WithHsDocIdentifiers a pass
WithHsDocIdentifiers HsDocString
str [])
                                                                                 <$> maybe_doc_hdr })
        ; -- If the whole module is warned about or deprecated
          -- (via mod_deprec) record that in tcg_warns. If we do thereby add
          -- a WarnAll, it will override any subsequent deprecations added to tcg_warns
        ; TcGblEnv
tcg_env1 <- case Maybe (LocatedP (WarningTxt GhcPs))
mod_deprec of
                             Just (L SrcSpanAnnP
_ WarningTxt GhcPs
txt) -> do { WarningTxt (GhcPass 'Renamed)
txt' <- WarningTxt GhcPs -> RnM (WarningTxt (GhcPass 'Renamed))
rnWarningTxt WarningTxt GhcPs
txt
                                                  ; TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (f :: * -> *) a. Applicative f => a -> f a
pure (TcGblEnv -> TcM TcGblEnv) -> TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ TcGblEnv
tcg_env {tcg_warns = WarnAll txt'}
                                                  }
                             Maybe (LocatedP (WarningTxt GhcPs))
Nothing            -> TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (f :: * -> *) a. Applicative f => a -> f a
pure TcGblEnv
tcg_env
        ; TcGblEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env1
          (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ do { -- Rename and type check the declarations
                 String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn1a" SDoc
forall doc. IsOutput doc => doc
empty
               ; TcGblEnv
tcg_env <-
                   case HscSource
hsc_src of
                    HsBootOrSig HsBootOrSig
boot_or_sig ->
                      do { TcGblEnv
tcg_env <- HsBootOrSig -> [LHsDecl GhcPs] -> TcM TcGblEnv
tcRnHsBootDecls HsBootOrSig
boot_or_sig [LHsDecl GhcPs]
local_decls
                         ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn4a: before exports" SDoc
forall doc. IsOutput doc => doc
empty
                         ; TcGblEnv
tcg_env <- TcGblEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$
                                      Bool
-> Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
-> TcM TcGblEnv
rnExports Bool
explicit_mod_hdr Maybe (XRec GhcPs [XRec GhcPs (IE GhcPs)])
Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
export_ies
                         ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn4b: after exports" SDoc
forall doc. IsOutput doc => doc
empty
                         ; TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return TcGblEnv
tcg_env
                         }
                    HscSource
HsSrcFile ->
                      {-# SCC "tcRnSrcDecls" #-}
                        Bool
-> Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
-> [LHsDecl GhcPs]
-> TcM TcGblEnv
tcRnSrcDecls Bool
explicit_mod_hdr Maybe (XRec GhcPs [XRec GhcPs (IE GhcPs)])
Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
export_ies [LHsDecl GhcPs]
local_decls

               ; TcRnIf TcGblEnv TcLclEnv Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (m :: * -> *). Monad m => m Bool -> m () -> m ()
whenM (GeneralFlag -> TcRnIf TcGblEnv TcLclEnv Bool
forall gbl lcl. GeneralFlag -> TcRnIf gbl lcl Bool
goptM GeneralFlag
Opt_DoCoreLinting) (IOEnv (Env TcGblEnv TcLclEnv) ()
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
                 Logger -> DynFlags -> TcGblEnv -> IOEnv (Env TcGblEnv TcLclEnv) ()
lintGblEnv (HscEnv -> Logger
hsc_logger HscEnv
hsc_env) (HscEnv -> DynFlags
hsc_dflags HscEnv
hsc_env) TcGblEnv
tcg_env

               ; TcGblEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env
                 (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ do { -- Compare hi-boot iface (if any) with the real thing
                        -- Must be done after processing the exports
                        TcGblEnv
tcg_env <- TcGblEnv -> SelfBootInfo -> TcM TcGblEnv
checkHiBootIface TcGblEnv
tcg_env SelfBootInfo
boot_info
                      ; -- The new type env is already available to stuff
                        -- slurped from interface files, via
                        -- GHC.Tc.Utils.Env.setGlobalTypeEnv. It's important that this
                        -- includes the stuff in checkHiBootIface,
                        -- because the latter might add new bindings for
                        -- boot_dfuns, which may be mentioned in imported
                        -- unfoldings.
                      ; -- Report unused names
                        -- Do this /after/ type inference, so that when reporting
                        -- a function with no type signature we can give the
                        -- inferred type
                      ; TcGblEnv -> HscSource -> IOEnv (Env TcGblEnv TcLclEnv) ()
reportUnusedNames TcGblEnv
tcg_env HscSource
hsc_src

                      -- Rename the module header properly after we have renamed everything else
                      ; Maybe (GenLocated SrcSpan (HsDoc (GhcPass 'Renamed)))
maybe_doc_hdr <- (LHsDoc GhcPs
 -> IOEnv
      (Env TcGblEnv TcLclEnv)
      (GenLocated SrcSpan (HsDoc (GhcPass 'Renamed))))
-> Maybe (LHsDoc GhcPs)
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (Maybe (GenLocated SrcSpan (HsDoc (GhcPass 'Renamed))))
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> Maybe a -> f (Maybe b)
traverse LHsDoc GhcPs
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (GenLocated SrcSpan (HsDoc (GhcPass 'Renamed)))
rnLHsDoc Maybe (LHsDoc GhcPs)
maybe_doc_hdr;
                      ; TcGblEnv
tcg_env <- TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env
                                            { tcg_doc_hdr = maybe_doc_hdr })

                      ; -- add extra source files to tcg_dependent_files
                        [String] -> IOEnv (Env TcGblEnv TcLclEnv) ()
addDependentFiles [String]
src_files
                        -- Ensure plugins run with the same tcg_env that we pass in
                      ; TcGblEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env
                        (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ do { TcGblEnv
tcg_env <- ModSummary -> TcGblEnv -> TcM TcGblEnv
runTypecheckerPlugin ModSummary
mod_sum TcGblEnv
tcg_env
                             ; -- Dump output and return
                               TcGblEnv -> IOEnv (Env TcGblEnv TcLclEnv) ()
tcDump TcGblEnv
tcg_env
                             ; TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return TcGblEnv
tcg_env
                             }
                      }
               }
        }
      }

{-
************************************************************************
*                                                                      *
                Import declarations
*                                                                      *
************************************************************************
-}

tcRnImports :: HscEnv -> [(LImportDecl GhcPs, SDoc)] -> TcM TcGblEnv
tcRnImports :: HscEnv -> [(LImportDecl GhcPs, SDoc)] -> TcM TcGblEnv
tcRnImports HscEnv
hsc_env [(LImportDecl GhcPs, SDoc)]
import_decls
  = do  { ([GenLocated SrcSpanAnnA (ImportDecl (GhcPass 'Renamed))]
rn_imports, GlobalRdrEnv
rdr_env, ImportAvails
imports, Bool
hpc_info) <- [(LImportDecl GhcPs, SDoc)]
-> RnM
     ([LImportDecl (GhcPass 'Renamed)], GlobalRdrEnv, ImportAvails,
      Bool)
rnImports [(LImportDecl GhcPs, SDoc)]
import_decls ;

        ; Module
this_mod <- IOEnv (Env TcGblEnv TcLclEnv) Module
forall (m :: * -> *). HasModule m => m Module
getModule
        ; TcGblEnv
gbl_env <- TcM TcGblEnv
forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
        ; let { -- We want instance declarations from all home-package
                -- modules below this one, including boot modules, except
                -- ourselves.  The 'except ourselves' is so that we don't
                -- get the instances from this module's hs-boot file.  This
                -- filtering also ensures that we don't see instances from
                -- modules batch (@--make@) compiled before this one, but
                -- which are not below this one.
              ; (InstEnv
home_insts, [FamInst]
home_fam_insts) =

                    HscEnv -> UnitId -> ModuleNameWithIsBoot -> (InstEnv, [FamInst])
hptInstancesBelow HscEnv
hsc_env (HomeUnit -> UnitId
forall u. GenHomeUnit u -> UnitId
homeUnitId (HomeUnit -> UnitId) -> HomeUnit -> UnitId
forall a b. (a -> b) -> a -> b
$ HscEnv -> HomeUnit
hsc_home_unit HscEnv
hsc_env) (ModuleName -> IsBootInterface -> ModuleNameWithIsBoot
forall mod. mod -> IsBootInterface -> GenWithIsBoot mod
GWIB (Module -> ModuleName
forall unit. GenModule unit -> ModuleName
moduleName Module
this_mod)(HscSource -> IsBootInterface
hscSourceToIsBoot (TcGblEnv -> HscSource
tcg_src TcGblEnv
gbl_env)))

              } ;

                -- Record boot-file info in the EPS, so that it's
                -- visible to loadHiBootInterface in tcRnSrcDecls,
                -- and any other incrementally-performed imports
              ; Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (GhcMode -> Bool
isOneShot (DynFlags -> GhcMode
ghcMode (HscEnv -> DynFlags
hsc_dflags HscEnv
hsc_env))) (IOEnv (Env TcGblEnv TcLclEnv) ()
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ do {
                  (ExternalPackageState -> ExternalPackageState)
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall gbl lcl.
(ExternalPackageState -> ExternalPackageState) -> TcRnIf gbl lcl ()
updateEps_ ((ExternalPackageState -> ExternalPackageState)
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> (ExternalPackageState -> ExternalPackageState)
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ \ExternalPackageState
eps  -> ExternalPackageState
eps { eps_is_boot = imp_boot_mods imports }
               }

                -- Update the gbl env
        ; (TcGblEnv -> TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl lcl a.
(gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
updGblEnv ( \ TcGblEnv
gbl ->
            TcGblEnv
gbl {
              tcg_rdr_env      = tcg_rdr_env gbl `plusGlobalRdrEnv` rdr_env,
              tcg_imports      = tcg_imports gbl `plusImportAvails` imports,
              tcg_rn_imports   = rn_imports,
              tcg_inst_env     = tcg_inst_env gbl `unionInstEnv` home_insts,
              tcg_fam_inst_env = extendFamInstEnvList (tcg_fam_inst_env gbl)
                                                      home_fam_insts,
              tcg_hpc          = hpc_info
            }) (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ do {

        ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn1" (InstalledModuleEnv ModuleNameWithIsBoot -> SDoc
forall a. Outputable a => a -> SDoc
ppr (ImportAvails -> InstalledModuleEnv ModuleNameWithIsBoot
imp_direct_dep_mods ImportAvails
imports))
                -- Fail if there are any errors so far
                -- The error printing (if needed) takes advantage
                -- of the tcg_env we have now set
--      ; traceIf (text "rdr_env: " <+> ppr rdr_env)
        ; IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM

                -- Load any orphan-module (including orphan family
                -- instance-module) interfaces, so that their rules and
                -- instance decls will be found.  But filter out a
                -- self hs-boot: these instances will be checked when
                -- we define them locally.
                -- (We don't need to load non-orphan family instance
                -- modules until we either try to use the instances they
                -- define, or define our own family instances, at which
                -- point we need to check them for consistency.)
        ; SDoc -> [Module] -> IOEnv (Env TcGblEnv TcLclEnv) ()
loadModuleInterfaces (String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"Loading orphan modules")
                               ((Module -> Bool) -> [Module] -> [Module]
forall a. (a -> Bool) -> [a] -> [a]
filter (Module -> Module -> Bool
forall a. Eq a => a -> a -> Bool
/= Module
this_mod) (ImportAvails -> [Module]
imp_orphs ImportAvails
imports))

                -- Check type-family consistency between imports.
                -- See Note [The type family instance consistency story]
        ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn1: checking family instance consistency {" SDoc
forall doc. IsOutput doc => doc
empty
        ; let { dir_imp_mods :: [Module]
dir_imp_mods = ModuleEnv [ImportedBy] -> [Module]
forall a. ModuleEnv a -> [Module]
moduleEnvKeys
                             (ModuleEnv [ImportedBy] -> [Module])
-> (ImportAvails -> ModuleEnv [ImportedBy])
-> ImportAvails
-> [Module]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ImportAvails -> ModuleEnv [ImportedBy]
imp_mods
                             (ImportAvails -> [Module]) -> ImportAvails -> [Module]
forall a b. (a -> b) -> a -> b
$ ImportAvails
imports }
        ; [Module] -> IOEnv (Env TcGblEnv TcLclEnv) ()
checkFamInstConsistency [Module]
dir_imp_mods
        ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn1: } checking family instance consistency" SDoc
forall doc. IsOutput doc => doc
empty

        ; TcM TcGblEnv
forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv } }

{-
************************************************************************
*                                                                      *
        Type-checking the top level of a module
*                                                                      *
************************************************************************
-}

tcRnSrcDecls :: Bool  -- False => no 'module M(..) where' header at all
             -> Maybe (LocatedL [LIE GhcPs])
             -> [LHsDecl GhcPs]               -- Declarations
             -> TcM TcGblEnv
tcRnSrcDecls :: Bool
-> Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
-> [LHsDecl GhcPs]
-> TcM TcGblEnv
tcRnSrcDecls Bool
explicit_mod_hdr Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
export_ies [LHsDecl GhcPs]
decls
 = do { -- Do all the declarations
      ; (TcGblEnv
tcg_env, TcLclEnv
tcl_env, WantedConstraints
lie) <- [LHsDecl GhcPs] -> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
tc_rn_src_decls [LHsDecl GhcPs]
decls

      ------ Simplify constraints ---------
      --
      -- We do this after checkMainType, so that we use the type
      -- info that checkMainType adds
      --
      -- We do it with both global and local env in scope:
      --  * the global env exposes the instances to simplifyTop,
      --    and affects how names are rendered in error messages
      --  * the local env exposes the local Ids to simplifyTop,
      --    so that we get better error messages (monomorphism restriction)
      ; Bag EvBind
new_ev_binds <- {-# SCC "simplifyTop" #-}
                        (TcGblEnv, TcLclEnv) -> TcRn (Bag EvBind) -> TcRn (Bag EvBind)
forall a. (TcGblEnv, TcLclEnv) -> TcRn a -> TcRn a
restoreEnvs (TcGblEnv
tcg_env, TcLclEnv
tcl_env) (TcRn (Bag EvBind) -> TcRn (Bag EvBind))
-> TcRn (Bag EvBind) -> TcRn (Bag EvBind)
forall a b. (a -> b) -> a -> b
$
                        do { WantedConstraints
lie_main <- TcGblEnv -> TcRn WantedConstraints
checkMainType TcGblEnv
tcg_env
                           ; WantedConstraints -> TcRn (Bag EvBind)
simplifyTop (WantedConstraints
lie WantedConstraints -> WantedConstraints -> WantedConstraints
`andWC` WantedConstraints
lie_main) }

        -- Emit Typeable bindings
      ; TcGblEnv
tcg_env <- TcGblEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$
                   TcM TcGblEnv
mkTypeableBinds

      ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc9" SDoc
forall doc. IsOutput doc => doc
empty
      ; IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM    -- Stop now if if there have been errors
                       -- Continuing is a waste of time; and we may get debug
                       -- warnings when zonking about strangely-typed TyCons!

        -- Zonk the final code.  This must be done last.
        -- Even simplifyTop may do some unification.
        -- This pass also warns about missing type signatures
      ; (TypeEnv
id_env, Bag EvBind
ev_binds', Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
binds', [GenLocated SrcSpanAnnA (ForeignDecl GhcTc)]
fords', [LTcSpecPrag]
imp_specs', [GenLocated SrcSpanAnnA (RuleDecl GhcTc)]
rules')
            <- Bag EvBind
-> TcGblEnv
-> TcM
     (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
      [LTcSpecPrag], [LRuleDecl GhcTc])
zonkTcGblEnv Bag EvBind
new_ev_binds TcGblEnv
tcg_env

      --------- Run finalizers --------------
      -- Finalizers must run after constraints are simplified, lest types
      --    might not be complete when using reify (see #12777).
      -- and also after we zonk the first time because we run typed splices
      --    in the zonker which gives rise to the finalisers.
      ; let -- init_tcg_env:
            --   * Remove accumulated bindings, rules and so on from
            --     TcGblEnv.  They are now in ev_binds', binds', etc.
            --   * Add the zonked Ids from the value bindings to tcg_type_env
            --     Up to now these Ids are only in tcl_env's type-envt
            init_tcg_env :: TcGblEnv
init_tcg_env = TcGblEnv
tcg_env { tcg_binds     = emptyBag
                                   , tcg_ev_binds  = emptyBag
                                   , tcg_imp_specs = []
                                   , tcg_rules     = []
                                   , tcg_fords     = []
                                   , tcg_type_env  = tcg_type_env tcg_env
                                                     `plusTypeEnv` id_env }
      ; (TcGblEnv
tcg_env, TcLclEnv
tcl_env) <- TcGblEnv
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
init_tcg_env
                              TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
run_th_modfinalizers
      ; IOEnv (Env TcGblEnv TcLclEnv) ()
finishTH
      ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc11" SDoc
forall doc. IsOutput doc => doc
empty

      --------- Deal with the exports ----------
      -- Can't be done earlier, because the export list must "see"
      -- the declarations created by the finalizers
      ; TcGblEnv
tcg_env <- (TcGblEnv, TcLclEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a. (TcGblEnv, TcLclEnv) -> TcRn a -> TcRn a
restoreEnvs (TcGblEnv
tcg_env, TcLclEnv
tcl_env) (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$
                   Bool
-> Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
-> TcM TcGblEnv
rnExports Bool
explicit_mod_hdr Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
export_ies

      --------- Emit the ':Main.main = runMainIO main' declaration ----------
      -- Do this /after/ rnExports, so that it can consult
      -- the tcg_exports created by rnExports
      ; (TcGblEnv
tcg_env, Bag EvBind
main_ev_binds)
           <- (TcGblEnv, TcLclEnv)
-> TcRn (TcGblEnv, Bag EvBind) -> TcRn (TcGblEnv, Bag EvBind)
forall a. (TcGblEnv, TcLclEnv) -> TcRn a -> TcRn a
restoreEnvs (TcGblEnv
tcg_env, TcLclEnv
tcl_env) (TcRn (TcGblEnv, Bag EvBind) -> TcRn (TcGblEnv, Bag EvBind))
-> TcRn (TcGblEnv, Bag EvBind) -> TcRn (TcGblEnv, Bag EvBind)
forall a b. (a -> b) -> a -> b
$
              do { (TcGblEnv
tcg_env, WantedConstraints
lie) <- TcM TcGblEnv -> TcM (TcGblEnv, WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureTopConstraints (TcM TcGblEnv -> TcM (TcGblEnv, WantedConstraints))
-> TcM TcGblEnv -> TcM (TcGblEnv, WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                                     Bool
-> Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
-> TcM TcGblEnv
checkMain Bool
explicit_mod_hdr Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
export_ies
                 ; Bag EvBind
ev_binds <- WantedConstraints -> TcRn (Bag EvBind)
simplifyTop WantedConstraints
lie
                 ; (TcGblEnv, Bag EvBind) -> TcRn (TcGblEnv, Bag EvBind)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env, Bag EvBind
ev_binds) }

      ; IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM    -- Stop now if if there have been errors
                       -- Continuing is a waste of time; and we may get debug
                       -- warnings when zonking about strangely-typed TyCons!

      ---------- Final zonking ---------------
      -- Zonk the new bindings arising from running the finalisers,
      -- and main. This won't give rise to any more finalisers as you
      -- can't nest finalisers inside finalisers.
      ; (TypeEnv
id_env_mf, Bag EvBind
ev_binds_mf, Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
binds_mf, [GenLocated SrcSpanAnnA (ForeignDecl GhcTc)]
fords_mf, [LTcSpecPrag]
imp_specs_mf, [GenLocated SrcSpanAnnA (RuleDecl GhcTc)]
rules_mf)
            <- Bag EvBind
-> TcGblEnv
-> TcM
     (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
      [LTcSpecPrag], [LRuleDecl GhcTc])
zonkTcGblEnv Bag EvBind
main_ev_binds TcGblEnv
tcg_env

      ; let { !final_type_env :: TypeEnv
final_type_env = TcGblEnv -> TypeEnv
tcg_type_env TcGblEnv
tcg_env
                                TypeEnv -> TypeEnv -> TypeEnv
`plusTypeEnv` TypeEnv
id_env_mf
              -- Add the zonked Ids from the value bindings (they were in tcl_env)
              -- Force !final_type_env, lest we retain an old reference
              -- to the previous tcg_env

            ; tcg_env' :: TcGblEnv
tcg_env' = TcGblEnv
tcg_env
                          { tcg_binds     = binds'    `unionBags` binds_mf
                          , tcg_ev_binds  = ev_binds' `unionBags` ev_binds_mf
                          , tcg_imp_specs = imp_specs' ++ imp_specs_mf
                          , tcg_rules     = rules'     ++ rules_mf
                          , tcg_fords     = fords'     ++ fords_mf } } ;

      ; TcGblEnv -> TypeEnv -> TcM TcGblEnv
setGlobalTypeEnv TcGblEnv
tcg_env' TypeEnv
final_type_env
   }

zonkTcGblEnv :: Bag EvBind -> TcGblEnv
             -> TcM (TypeEnv, Bag EvBind, LHsBinds GhcTc,
                       [LForeignDecl GhcTc], [LTcSpecPrag], [LRuleDecl GhcTc])
zonkTcGblEnv :: Bag EvBind
-> TcGblEnv
-> TcM
     (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
      [LTcSpecPrag], [LRuleDecl GhcTc])
zonkTcGblEnv Bag EvBind
ev_binds tcg_env :: TcGblEnv
tcg_env@(TcGblEnv { tcg_binds :: TcGblEnv -> LHsBinds GhcTc
tcg_binds     = LHsBinds GhcTc
binds
                                        , tcg_ev_binds :: TcGblEnv -> Bag EvBind
tcg_ev_binds  = Bag EvBind
cur_ev_binds
                                        , tcg_imp_specs :: TcGblEnv -> [LTcSpecPrag]
tcg_imp_specs = [LTcSpecPrag]
imp_specs
                                        , tcg_rules :: TcGblEnv -> [LRuleDecl GhcTc]
tcg_rules     = [LRuleDecl GhcTc]
rules
                                        , tcg_fords :: TcGblEnv -> [LForeignDecl GhcTc]
tcg_fords     = [LForeignDecl GhcTc]
fords })
  = {-# SCC "zonkTopDecls" #-}
    TcGblEnv
-> TcM
     (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
      [LTcSpecPrag], [LRuleDecl GhcTc])
-> TcM
     (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
      [LTcSpecPrag], [LRuleDecl GhcTc])
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env (TcM
   (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
    [LTcSpecPrag], [LRuleDecl GhcTc])
 -> TcM
      (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
       [LTcSpecPrag], [LRuleDecl GhcTc]))
-> TcM
     (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
      [LTcSpecPrag], [LRuleDecl GhcTc])
-> TcM
     (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
      [LTcSpecPrag], [LRuleDecl GhcTc])
forall a b. (a -> b) -> a -> b
$ -- This sets the GlobalRdrEnv which is used when rendering
                        --   error messages during zonking (notably levity errors)
    do { let all_ev_binds :: Bag EvBind
all_ev_binds = Bag EvBind
cur_ev_binds Bag EvBind -> Bag EvBind -> Bag EvBind
forall a. Bag a -> Bag a -> Bag a
`unionBags` Bag EvBind
ev_binds
       ; Bag EvBind
-> LHsBinds GhcTc
-> [LRuleDecl GhcTc]
-> [LTcSpecPrag]
-> [LForeignDecl GhcTc]
-> TcM
     (TypeEnv, Bag EvBind, LHsBinds GhcTc, [LForeignDecl GhcTc],
      [LTcSpecPrag], [LRuleDecl GhcTc])
zonkTopDecls Bag EvBind
all_ev_binds LHsBinds GhcTc
binds [LRuleDecl GhcTc]
rules [LTcSpecPrag]
imp_specs [LForeignDecl GhcTc]
fords }

-- | Runs TH finalizers and renames and typechecks the top-level declarations
-- that they could introduce.
run_th_modfinalizers :: TcM (TcGblEnv, TcLclEnv)
run_th_modfinalizers :: TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
run_th_modfinalizers = do
  TcRef [(TcLclEnv, ThModFinalizers)]
th_modfinalizers_var <- (TcGblEnv -> TcRef [(TcLclEnv, ThModFinalizers)])
-> TcM TcGblEnv
-> IOEnv
     (Env TcGblEnv TcLclEnv) (TcRef [(TcLclEnv, ThModFinalizers)])
forall a b.
(a -> b)
-> IOEnv (Env TcGblEnv TcLclEnv) a
-> IOEnv (Env TcGblEnv TcLclEnv) b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> TcRef [(TcLclEnv, ThModFinalizers)]
tcg_th_modfinalizers TcM TcGblEnv
forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
  [(TcLclEnv, ThModFinalizers)]
th_modfinalizers <- TcRef [(TcLclEnv, ThModFinalizers)]
-> IOEnv (Env TcGblEnv TcLclEnv) [(TcLclEnv, ThModFinalizers)]
forall (m :: * -> *) a. MonadIO m => TcRef a -> m a
readTcRef TcRef [(TcLclEnv, ThModFinalizers)]
th_modfinalizers_var
  if [(TcLclEnv, ThModFinalizers)] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [(TcLclEnv, ThModFinalizers)]
th_modfinalizers
  then TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall gbl lcl. TcRnIf gbl lcl (gbl, lcl)
getEnvs
  else do
    TcRef [(TcLclEnv, ThModFinalizers)]
-> [(TcLclEnv, ThModFinalizers)]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (m :: * -> *) a. MonadIO m => TcRef a -> a -> m ()
writeTcRef TcRef [(TcLclEnv, ThModFinalizers)]
th_modfinalizers_var []
    let run_finalizer :: (TcLclEnv, ThModFinalizers) -> IOEnv (Env TcGblEnv TcLclEnv) ()
run_finalizer (TcLclEnv
lcl_env, ThModFinalizers
f) =
            TcLclEnv
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall gbl a.
TcLclEnv -> TcRnIf gbl TcLclEnv a -> TcRnIf gbl TcLclEnv a
restoreLclEnv TcLclEnv
lcl_env (ThModFinalizers -> IOEnv (Env TcGblEnv TcLclEnv) ()
runRemoteModFinalizers ThModFinalizers
f)

    (()
_, WantedConstraints
lie_th) <- IOEnv (Env TcGblEnv TcLclEnv) () -> TcM ((), WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureTopConstraints (IOEnv (Env TcGblEnv TcLclEnv) () -> TcM ((), WantedConstraints))
-> IOEnv (Env TcGblEnv TcLclEnv) () -> TcM ((), WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                   ((TcLclEnv, ThModFinalizers) -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> [(TcLclEnv, ThModFinalizers)]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ (TcLclEnv, ThModFinalizers) -> IOEnv (Env TcGblEnv TcLclEnv) ()
run_finalizer [(TcLclEnv, ThModFinalizers)]
th_modfinalizers

      -- Finalizers can add top-level declarations with addTopDecls, so
      -- we have to run tc_rn_src_decls to get them
    (TcGblEnv
tcg_env, TcLclEnv
tcl_env, WantedConstraints
lie_top_decls) <- [LHsDecl GhcPs] -> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
tc_rn_src_decls []

    (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a. (TcGblEnv, TcLclEnv) -> TcRn a -> TcRn a
restoreEnvs (TcGblEnv
tcg_env, TcLclEnv
tcl_env) (TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
 -> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv))
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a b. (a -> b) -> a -> b
$ do
      -- Subsequent rounds of finalizers run after any new constraints are
      -- simplified, or some types might not be complete when using reify
      -- (see #12777).
      Bag EvBind
new_ev_binds <- {-# SCC "simplifyTop2" #-}
                      WantedConstraints -> TcRn (Bag EvBind)
simplifyTop (WantedConstraints
lie_th WantedConstraints -> WantedConstraints -> WantedConstraints
`andWC` WantedConstraints
lie_top_decls)
      Bag EvBind
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a. Bag EvBind -> TcM a -> TcM a
addTopEvBinds Bag EvBind
new_ev_binds TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
run_th_modfinalizers
        -- addTopDecls can add declarations which add new finalizers.

tc_rn_src_decls :: [LHsDecl GhcPs]
                -> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
-- Loops around dealing with each top level inter-splice group
-- in turn, until it's dealt with the entire module
-- Never emits constraints; calls captureTopConstraints internally
tc_rn_src_decls :: [LHsDecl GhcPs] -> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
tc_rn_src_decls [LHsDecl GhcPs]
ds
 = {-# SCC "tc_rn_src_decls" #-}
   do { (HsGroup GhcPs
first_group, Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
group_tail) <- [LHsDecl GhcPs]
-> RnM (HsGroup GhcPs, Maybe (SpliceDecl GhcPs, [LHsDecl GhcPs]))
findSplice [LHsDecl GhcPs]
ds
                -- If ds is [] we get ([], Nothing)

        -- Deal with decls up to, but not including, the first splice
      ; (TcGblEnv
tcg_env, HsGroup (GhcPass 'Renamed)
rn_decls) <- HsGroup GhcPs -> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
rnTopSrcDecls HsGroup GhcPs
first_group
                -- rnTopSrcDecls fails if there are any errors

        -- Get TH-generated top-level declarations and make sure they don't
        -- contain any splices since we don't handle that at the moment
        --
        -- The plumbing here is a bit odd: see #10853
      ; TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
th_topdecls_var <- (TcGblEnv -> TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
-> TcM TcGblEnv
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
forall a b.
(a -> b)
-> IOEnv (Env TcGblEnv TcLclEnv) a
-> IOEnv (Env TcGblEnv TcLclEnv) b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> TcRef [LHsDecl GhcPs]
TcGblEnv -> TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
tcg_th_topdecls TcM TcGblEnv
forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
      ; [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
th_ds <- TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
-> IOEnv
     (Env TcGblEnv TcLclEnv) [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
forall (m :: * -> *) a. MonadIO m => TcRef a -> m a
readTcRef TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
th_topdecls_var
      ; TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
-> [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (m :: * -> *) a. MonadIO m => TcRef a -> a -> m ()
writeTcRef TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
th_topdecls_var []

      ; (TcGblEnv
tcg_env, HsGroup (GhcPass 'Renamed)
rn_decls) <-
            if [GenLocated SrcSpanAnnA (HsDecl GhcPs)] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
th_ds
            then (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env, HsGroup (GhcPass 'Renamed)
rn_decls)
            else do { (HsGroup GhcPs
th_group, Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
th_group_tail) <- [LHsDecl GhcPs]
-> RnM (HsGroup GhcPs, Maybe (SpliceDecl GhcPs, [LHsDecl GhcPs]))
findSplice [LHsDecl GhcPs]
[GenLocated SrcSpanAnnA (HsDecl GhcPs)]
th_ds
                    ; case Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
th_group_tail of
                        { Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
Nothing -> () -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ()
                        ; Just (SpliceDecl XSpliceDecl GhcPs
_ (L SrcSpanAnnA
loc HsUntypedSplice GhcPs
_) SpliceDecoration
_, [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
_) ->
                            SrcSpanAnnA
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall ann a. SrcSpanAnn' ann -> TcRn a -> TcRn a
setSrcSpanA SrcSpanAnnA
loc (IOEnv (Env TcGblEnv TcLclEnv) ()
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErr (TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
                            THError -> TcRnMessage
TcRnTHError (THError -> TcRnMessage) -> THError -> TcRnMessage
forall a b. (a -> b) -> a -> b
$ AddTopDeclsError -> THError
AddTopDeclsError
                              AddTopDeclsError
AddTopDeclsUnexpectedDeclarationSplice
                        }
                      -- Rename TH-generated top-level declarations
                    ; (TcGblEnv
tcg_env, HsGroup (GhcPass 'Renamed)
th_rn_decls) <- TcGblEnv
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env
                        (TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
 -> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed)))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$ HsGroup GhcPs -> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
rnTopSrcDecls HsGroup GhcPs
th_group

                      -- Dump generated top-level declarations
                    ; let msg :: String
msg = String
"top-level declarations added with 'addTopDecls'"
                    ; SpliceInfo -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceSplice
                        (SpliceInfo -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> SpliceInfo -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ SpliceInfo { spliceDescription :: String
spliceDescription = String
msg
                                     , spliceIsDecl :: Bool
spliceIsDecl    = Bool
True
                                     , spliceSource :: Maybe (LHsExpr (GhcPass 'Renamed))
spliceSource    = Maybe (LHsExpr (GhcPass 'Renamed))
Maybe (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall a. Maybe a
Nothing
                                     , spliceGenerated :: SDoc
spliceGenerated = HsGroup (GhcPass 'Renamed) -> SDoc
forall a. Outputable a => a -> SDoc
ppr HsGroup (GhcPass 'Renamed)
th_rn_decls }
                    ; (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env, HsGroup (GhcPass 'Renamed)
-> HsGroup (GhcPass 'Renamed) -> HsGroup (GhcPass 'Renamed)
forall (p :: Pass).
HsGroup (GhcPass p) -> HsGroup (GhcPass p) -> HsGroup (GhcPass p)
appendGroups HsGroup (GhcPass 'Renamed)
rn_decls HsGroup (GhcPass 'Renamed)
th_rn_decls)
                    }

      -- Type check all declarations
      -- NB: set the env **before** captureTopConstraints so that error messages
      -- get reported w.r.t. the right GlobalRdrEnv. It is for this reason that
      -- the captureTopConstraints must go here, not in tcRnSrcDecls.
      ; ((TcGblEnv
tcg_env, TcLclEnv
tcl_env), WantedConstraints
lie1) <- TcGblEnv
-> TcRnIf
     TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints)
-> TcRnIf
     TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints)
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env (TcRnIf TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints)
 -> TcRnIf
      TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints))
-> TcRnIf
     TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints)
-> TcRnIf
     TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                                      TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf
     TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureTopConstraints (TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
 -> TcRnIf
      TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints))
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf
     TcGblEnv TcLclEnv ((TcGblEnv, TcLclEnv), WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                                      HsGroup (GhcPass 'Renamed)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
tcTopSrcDecls HsGroup (GhcPass 'Renamed)
rn_decls

        -- If there is no splice, we're nearly done
      ; (TcGblEnv, TcLclEnv)
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
forall a. (TcGblEnv, TcLclEnv) -> TcRn a -> TcRn a
restoreEnvs (TcGblEnv
tcg_env, TcLclEnv
tcl_env) (TcM (TcGblEnv, TcLclEnv, WantedConstraints)
 -> TcM (TcGblEnv, TcLclEnv, WantedConstraints))
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
forall a b. (a -> b) -> a -> b
$
        case Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
group_tail of
          { Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
Nothing -> (TcGblEnv, TcLclEnv, WantedConstraints)
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env, TcLclEnv
tcl_env, WantedConstraints
lie1)

            -- If there's a splice, we must carry on
          ; Just (SpliceDecl XSpliceDecl GhcPs
_ (L SrcSpanAnnA
_ HsUntypedSplice GhcPs
splice) SpliceDecoration
_, [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
rest_ds) ->
            do {
                 -- We need to simplify any constraints from the previous declaration
                 -- group, or else we might reify metavariables, as in #16980.
               ; Bag EvBind
ev_binds1 <- WantedConstraints -> TcRn (Bag EvBind)
simplifyTop WantedConstraints
lie1

                 -- Rename the splice expression, and get its supporting decls
               ; ([GenLocated SrcSpanAnnA (HsDecl GhcPs)]
spliced_decls, FreeVars
splice_fvs) <- HsUntypedSplice GhcPs -> RnM ([LHsDecl GhcPs], FreeVars)
rnTopSpliceDecls HsUntypedSplice GhcPs
splice

                 -- Glue them on the front of the remaining decls and loop
               ; TcGblEnv
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv (TcGblEnv
tcg_env TcGblEnv -> DefUses -> TcGblEnv
`addTcgDUs` FreeVars -> DefUses
usesOnly FreeVars
splice_fvs) (TcM (TcGblEnv, TcLclEnv, WantedConstraints)
 -> TcM (TcGblEnv, TcLclEnv, WantedConstraints))
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                 Bag EvBind
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
forall a. Bag EvBind -> TcM a -> TcM a
addTopEvBinds Bag EvBind
ev_binds1                             (TcM (TcGblEnv, TcLclEnv, WantedConstraints)
 -> TcM (TcGblEnv, TcLclEnv, WantedConstraints))
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
-> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                 [LHsDecl GhcPs] -> TcM (TcGblEnv, TcLclEnv, WantedConstraints)
tc_rn_src_decls ([GenLocated SrcSpanAnnA (HsDecl GhcPs)]
spliced_decls [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
-> [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
-> [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
forall a. [a] -> [a] -> [a]
++ [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
rest_ds)
               }
          }
      }

{-
************************************************************************
*                                                                      *
        Compiling hs-boot source files, and
        comparing the hi-boot interface with the real thing
*                                                                      *
************************************************************************
-}

tcRnHsBootDecls :: HsBootOrSig -> [LHsDecl GhcPs] -> TcM TcGblEnv
tcRnHsBootDecls :: HsBootOrSig -> [LHsDecl GhcPs] -> TcM TcGblEnv
tcRnHsBootDecls HsBootOrSig
boot_or_sig [LHsDecl GhcPs]
decls
   = do { (HsGroup GhcPs
first_group, Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
group_tail) <- [LHsDecl GhcPs]
-> RnM (HsGroup GhcPs, Maybe (SpliceDecl GhcPs, [LHsDecl GhcPs]))
findSplice [LHsDecl GhcPs]
decls

                -- Rename the declarations
        ; (TcGblEnv
tcg_env, HsGroup { hs_tyclds :: forall p. HsGroup p -> [TyClGroup p]
hs_tyclds = [TyClGroup (GhcPass 'Renamed)]
tycl_decls
                            , hs_derivds :: forall p. HsGroup p -> [LDerivDecl p]
hs_derivds = [LDerivDecl (GhcPass 'Renamed)]
deriv_decls
                            , hs_fords :: forall p. HsGroup p -> [LForeignDecl p]
hs_fords  = [LForeignDecl (GhcPass 'Renamed)]
for_decls
                            , hs_defds :: forall p. HsGroup p -> [LDefaultDecl p]
hs_defds  = [LDefaultDecl (GhcPass 'Renamed)]
def_decls
                            , hs_ruleds :: forall p. HsGroup p -> [LRuleDecls p]
hs_ruleds = [LRuleDecls (GhcPass 'Renamed)]
rule_decls
                            , hs_annds :: forall p. HsGroup p -> [LAnnDecl p]
hs_annds  = [LAnnDecl (GhcPass 'Renamed)]
_
                            , hs_valds :: forall p. HsGroup p -> HsValBinds p
hs_valds  = XValBindsLR (NValBinds [(RecFlag, LHsBinds (GhcPass 'Renamed))]
val_binds [LSig (GhcPass 'Renamed)]
val_sigs) })
              <- HsGroup GhcPs -> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
rnTopSrcDecls HsGroup GhcPs
first_group

        ; (TcGblEnv
gbl_env, WantedConstraints
lie) <- TcGblEnv
-> TcM (TcGblEnv, WantedConstraints)
-> TcM (TcGblEnv, WantedConstraints)
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env (TcM (TcGblEnv, WantedConstraints)
 -> TcM (TcGblEnv, WantedConstraints))
-> TcM (TcGblEnv, WantedConstraints)
-> TcM (TcGblEnv, WantedConstraints)
forall a b. (a -> b) -> a -> b
$ TcM TcGblEnv -> TcM (TcGblEnv, WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureTopConstraints (TcM TcGblEnv -> TcM (TcGblEnv, WantedConstraints))
-> TcM TcGblEnv -> TcM (TcGblEnv, WantedConstraints)
forall a b. (a -> b) -> a -> b
$ do {
              -- NB: setGblEnv **before** captureTopConstraints so that
              -- if the latter reports errors, it knows what's in scope

                -- Check for illegal declarations
        ; case Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
group_tail of
             Just (SpliceDecl XSpliceDecl GhcPs
_ XRec GhcPs (HsUntypedSplice GhcPs)
d SpliceDecoration
_, [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
_) -> HsBootOrSig
-> (NonEmpty (GenLocated SrcSpanAnnA (HsUntypedSplice GhcPs))
    -> BadBootDecls)
-> [GenLocated SrcSpanAnnA (HsUntypedSplice GhcPs)]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall decl.
HsBootOrSig
-> (NonEmpty (LocatedA decl) -> BadBootDecls)
-> [LocatedA decl]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
rejectBootDecls HsBootOrSig
boot_or_sig NonEmpty (GenLocated SrcSpanAnnA (HsUntypedSplice GhcPs))
-> BadBootDecls
BootSpliceDecls [XRec GhcPs (HsUntypedSplice GhcPs)
GenLocated SrcSpanAnnA (HsUntypedSplice GhcPs)
d]
             Maybe (SpliceDecl GhcPs, [GenLocated SrcSpanAnnA (HsDecl GhcPs)])
Nothing                    -> () -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ()
        ; HsBootOrSig
-> (NonEmpty (LocatedA (ForeignDecl (GhcPass 'Renamed)))
    -> BadBootDecls)
-> [LocatedA (ForeignDecl (GhcPass 'Renamed))]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall decl.
HsBootOrSig
-> (NonEmpty (LocatedA decl) -> BadBootDecls)
-> [LocatedA decl]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
rejectBootDecls HsBootOrSig
boot_or_sig NonEmpty (LForeignDecl (GhcPass 'Renamed)) -> BadBootDecls
NonEmpty (LocatedA (ForeignDecl (GhcPass 'Renamed)))
-> BadBootDecls
BootForeignDecls [LForeignDecl (GhcPass 'Renamed)]
[LocatedA (ForeignDecl (GhcPass 'Renamed))]
for_decls
        ; HsBootOrSig
-> (NonEmpty (LocatedA (DefaultDecl (GhcPass 'Renamed)))
    -> BadBootDecls)
-> [LocatedA (DefaultDecl (GhcPass 'Renamed))]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall decl.
HsBootOrSig
-> (NonEmpty (LocatedA decl) -> BadBootDecls)
-> [LocatedA decl]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
rejectBootDecls HsBootOrSig
boot_or_sig NonEmpty (LDefaultDecl (GhcPass 'Renamed)) -> BadBootDecls
NonEmpty (LocatedA (DefaultDecl (GhcPass 'Renamed)))
-> BadBootDecls
BootDefaultDecls [LDefaultDecl (GhcPass 'Renamed)]
[LocatedA (DefaultDecl (GhcPass 'Renamed))]
def_decls
        ; HsBootOrSig
-> (NonEmpty (LocatedA (RuleDecls (GhcPass 'Renamed)))
    -> BadBootDecls)
-> [LocatedA (RuleDecls (GhcPass 'Renamed))]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall decl.
HsBootOrSig
-> (NonEmpty (LocatedA decl) -> BadBootDecls)
-> [LocatedA decl]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
rejectBootDecls HsBootOrSig
boot_or_sig NonEmpty (LRuleDecls (GhcPass 'Renamed)) -> BadBootDecls
NonEmpty (LocatedA (RuleDecls (GhcPass 'Renamed))) -> BadBootDecls
BootRuleDecls    [LRuleDecls (GhcPass 'Renamed)]
[LocatedA (RuleDecls (GhcPass 'Renamed))]
rule_decls

                -- Typecheck type/class/instance decls
        ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc2 (boot)" SDoc
forall doc. IsOutput doc => doc
empty
        ; (TcGblEnv
tcg_env, [InstInfo (GhcPass 'Renamed)]
inst_infos, ThBindEnv
_deriv_binds, HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
_th_bndrs)
             <- [TyClGroup (GhcPass 'Renamed)]
-> [LDerivDecl (GhcPass 'Renamed)]
-> [(RecFlag, LHsBinds (GhcPass 'Renamed))]
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
tcTyClsInstDecls [TyClGroup (GhcPass 'Renamed)]
tycl_decls [LDerivDecl (GhcPass 'Renamed)]
deriv_decls [(RecFlag, LHsBinds (GhcPass 'Renamed))]
val_binds
        ; TcGblEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env     (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ do {

        -- Emit Typeable bindings
        ; TcGblEnv
tcg_env <- TcM TcGblEnv
mkTypeableBinds
        ; TcGblEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ do {

                -- Typecheck value declarations
        ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc5" SDoc
forall doc. IsOutput doc => doc
empty
        ; [Var]
val_ids <- [(RecFlag, LHsBinds (GhcPass 'Renamed))]
-> [LSig (GhcPass 'Renamed)] -> TcM [Var]
tcHsBootSigs [(RecFlag, LHsBinds (GhcPass 'Renamed))]
val_binds [LSig (GhcPass 'Renamed)]
val_sigs

                -- Wrap up
                -- No simplification or zonking to do
        ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc7a" SDoc
forall doc. IsOutput doc => doc
empty
        ; TcGblEnv
gbl_env <- TcM TcGblEnv
forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv

                -- Make the final type-env
                -- Include the dfun_ids so that their type sigs
                -- are written into the interface file.
        ; let { type_env0 :: TypeEnv
type_env0 = TcGblEnv -> TypeEnv
tcg_type_env TcGblEnv
gbl_env
              ; type_env1 :: TypeEnv
type_env1 = TypeEnv -> [Var] -> TypeEnv
extendTypeEnvWithIds TypeEnv
type_env0 [Var]
val_ids
              ; type_env2 :: TypeEnv
type_env2 = TypeEnv -> [Var] -> TypeEnv
extendTypeEnvWithIds TypeEnv
type_env1 [Var]
dfun_ids
              ; dfun_ids :: [Var]
dfun_ids = (InstInfo (GhcPass 'Renamed) -> Var)
-> [InstInfo (GhcPass 'Renamed)] -> [Var]
forall a b. (a -> b) -> [a] -> [b]
map InstInfo (GhcPass 'Renamed) -> Var
forall a. InstInfo a -> Var
iDFunId [InstInfo (GhcPass 'Renamed)]
inst_infos
              }

        ; TcGblEnv -> TypeEnv -> TcM TcGblEnv
setGlobalTypeEnv TcGblEnv
gbl_env TypeEnv
type_env2
   }}}
   ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"boot" (WantedConstraints -> SDoc
forall a. Outputable a => a -> SDoc
ppr WantedConstraints
lie); TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return TcGblEnv
gbl_env }

{-
Once we've typechecked the body of the module, we want to compare what
we've found (gathered in a TypeEnv) with the hi-boot details (if any).
-}

checkHiBootIface :: TcGblEnv -> SelfBootInfo -> TcM TcGblEnv
-- Compare the hi-boot file for this module (if there is one)
-- with the type environment we've just come up with
-- In the common case where there is no hi-boot file, the list
-- of boot_names is empty.

checkHiBootIface :: TcGblEnv -> SelfBootInfo -> TcM TcGblEnv
checkHiBootIface TcGblEnv
tcg_env SelfBootInfo
boot_info
  | SelfBootInfo
NoSelfBoot <- SelfBootInfo
boot_info  -- Common case
  = TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return TcGblEnv
tcg_env

  | HscSource
HsBootFile <- TcGblEnv -> HscSource
tcg_src TcGblEnv
tcg_env   -- Current module is already a hs-boot file!
  = TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return TcGblEnv
tcg_env

  | SelfBoot { sb_mds :: SelfBootInfo -> ModDetails
sb_mds = ModDetails
boot_details } <- SelfBootInfo
boot_info
  , TcGblEnv { tcg_binds :: TcGblEnv -> LHsBinds GhcTc
tcg_binds    = LHsBinds GhcTc
binds
             , tcg_insts :: TcGblEnv -> [ClsInst]
tcg_insts    = [ClsInst]
local_insts
             , tcg_type_env :: TcGblEnv -> TypeEnv
tcg_type_env = TypeEnv
local_type_env
             , tcg_exports :: TcGblEnv -> [AvailInfo]
tcg_exports  = [AvailInfo]
local_exports } <- TcGblEnv
tcg_env
  = do  { -- This code is tricky, see Note [DFun knot-tying]
        ; [(Var, Var)]
imp_prs <- [ClsInst]
-> TypeEnv -> [AvailInfo] -> ModDetails -> TcM [(Var, Var)]
checkHiBootIface' [ClsInst]
local_insts TypeEnv
local_type_env
                                       [AvailInfo]
local_exports ModDetails
boot_details

        -- Now add the impedance-matching boot bindings:
        --
        --  - dfun bindings  $fxblah = $fblah
        --  - record bindings fld{var} = fld{rec field of ..}
        --
        -- to (a) the type envt, and (b) the top-level bindings
        ; let boot_impedance_bds :: [Var]
boot_impedance_bds = ((Var, Var) -> Var) -> [(Var, Var)] -> [Var]
forall a b. (a -> b) -> [a] -> [b]
map (Var, Var) -> Var
forall a b. (a, b) -> a
fst [(Var, Var)]
imp_prs
              type_env' :: TypeEnv
type_env'          = TypeEnv -> [Var] -> TypeEnv
extendTypeEnvWithIds TypeEnv
local_type_env [Var]
boot_impedance_bds
              impedance_binds :: Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
impedance_binds    = [GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc)]
-> Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
forall a. [a] -> Bag a
listToBag [ IdP GhcTc -> LHsExpr GhcTc -> LHsBind GhcTc
mkVarBind IdP GhcTc
Var
boot_id (IdP GhcTc -> LHsExpr GhcTc
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP GhcTc
Var
id)
                                             | (Var
boot_id, Var
id) <- [(Var, Var)]
imp_prs ]
              tcg_env_w_binds :: TcGblEnv
tcg_env_w_binds
                = TcGblEnv
tcg_env { tcg_binds = binds `unionBags` impedance_binds }

        ; TypeEnv
type_env' TypeEnv -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. a -> b -> b
`seq`
             -- Why the seq?  Without, we will put a TypeEnv thunk in
             -- tcg_type_env_var.  That thunk will eventually get
             -- forced if we are typechecking interfaces, but that
             -- is no good if we are trying to typecheck the very
             -- DFun we were going to put in.
             -- TODO: Maybe setGlobalTypeEnv should be strict.
          TcGblEnv -> TypeEnv -> TcM TcGblEnv
setGlobalTypeEnv TcGblEnv
tcg_env_w_binds TypeEnv
type_env' }

#if __GLASGOW_HASKELL__ <= 810
  | otherwise = panic "checkHiBootIface: unreachable code"
#endif

{- Note [DFun impedance matching]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We return a list of "impedance-matching" bindings for the dfuns
defined in the hs-boot file, such as
          $fxEqT = $fEqT
We need these because the module and hi-boot file might differ in
the name it chose for the dfun: the name of a dfun is not
uniquely determined by its type; there might be multiple dfuns
which, individually, would map to the same name (in which case
we have to disambiguate them.)  There's no way for the hi file
to know exactly what disambiguation to use... without looking
at the hi-boot file itself.

In fact, the names will always differ because we always pick names
prefixed with "$fx" for boot dfuns, and "$f" for real dfuns
(so that this impedance matching is always possible).

Note [Record field impedance matching]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When a hs-boot file defines a function whose implementation in the hs file
is a record selector, we have to do something similar to Note [DFun impedance matching].

Example:

  -- M.hs-boot
  module M where
    data A
    fld :: A -> ()

  -- M.hs
  module M where
    data A = MkA { fld :: () }

Recall from Note [Record field namespacing] in GHC.Types.Name.Occurrence that
record fields have their own namespaces. This means that M.hs exports the Id
fld{record selector of MkA} :: A -> (), while M.hs-boot exports the Id
fld{variable} :: A -> ().

To remedy this, we add an impedance-matching binding in M.hs:

  fld{variable} :: A -> ()
  fld{variable} = fld{record selector of MkA}

Note that we imperatively need to add a binding for fld{variable} in M.hs, as we
might have an exact Name reference to it (e.g. in a module that imports M.hs-boot).
Not doing so would cause Core Lint errors, at the very least.

These bindings are returned by the check_export in checkHiBootIface', and
added to the DFun impedance-matching bindings.

[Wrinkle: exports]

  We MUST NOT add fld{variable} to the export list of M.hs, as this
  would mean that M.hs exports both a record field and variable with the same
  occNameFS, which would cause ambiguity errors at use-sites.
  It's OK to only export the field name even though the boot-file exported
  the variable: name resolution will take care of that.

Another situation is that we are re-exporting, e.g. (with M as above):

  -- N.hs-boot
  module N ( module M ) where
    import {-# SOURCE #-} M

  -- N.hs
  module N ( module M where )
    import M

In this case, N.hs-boot re-exports the variable fld, and N re-exports the
record field fld, but not the variable fld. We don't need to do anything in
this situation; in particular, don't re-export the variable name from N.hs,
as per [Wrinkle: exports] above.

Note [DFun knot-tying]
~~~~~~~~~~~~~~~~~~~~~~
The 'SelfBootInfo' that is fed into 'checkHiBootIface' comes from
typechecking the hi-boot file that we are presently implementing.
Suppose we are typechecking the module A: when we typecheck the
hi-boot file, whenever we see an identifier A.T, we knot-tie this
identifier to the *local* type environment (via if_rec_types.)  The
contract then is that we don't *look* at 'SelfBootInfo' until we've
finished typechecking the module and updated the type environment with
the new tycons and ids.

This most works well, but there is one problem: DFuns!  We do not want
to look at the mb_insts of the ModDetails in SelfBootInfo, because a
dfun in one of those ClsInsts is gotten (in GHC.IfaceToCore.tcIfaceInst) by a
(lazily evaluated) lookup in the if_rec_types.  We could extend the
type env, do a setGloblaTypeEnv etc; but that all seems very indirect.
It is much more directly simply to extract the DFunIds from the
md_types of the SelfBootInfo.

See #4003, #16038 for why we need to take care here.
-}

checkHiBootIface' :: [ClsInst] -> TypeEnv -> [AvailInfo]
                  -> ModDetails -> TcM [(Id, Id)]
-- Variant which doesn't require a full TcGblEnv; you could get the
-- local components from another ModDetails.
checkHiBootIface' :: [ClsInst]
-> TypeEnv -> [AvailInfo] -> ModDetails -> TcM [(Var, Var)]
checkHiBootIface'
        [ClsInst]
local_insts TypeEnv
local_type_env [AvailInfo]
local_exports
        (ModDetails { md_types :: ModDetails -> TypeEnv
md_types = TypeEnv
boot_type_env
                    , md_fam_insts :: ModDetails -> [FamInst]
md_fam_insts = [FamInst]
boot_fam_insts
                    , md_exports :: ModDetails -> [AvailInfo]
md_exports = [AvailInfo]
boot_exports })
  = do  { String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"checkHiBootIface" (SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat
             [ TypeEnv -> SDoc
forall a. Outputable a => a -> SDoc
ppr TypeEnv
boot_type_env, [AvailInfo] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [AvailInfo]
boot_exports ]

        ; GlobalRdrEnv
gre_env <- TcRn GlobalRdrEnv
getGlobalRdrEnv

                -- Check the exports of the boot module, one by one
        ; [(Var, Var)]
fld_prs <- (AvailInfo -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var)))
-> [AvailInfo] -> TcM [(Var, Var)]
forall (m :: * -> *) a b.
Applicative m =>
(a -> m (Maybe b)) -> [a] -> m [b]
mapMaybeM (GlobalRdrEnv
-> AvailInfo -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
check_export GlobalRdrEnv
gre_env) [AvailInfo]
boot_exports

                -- Check for no family instances
        ; Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless ([FamInst] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [FamInst]
boot_fam_insts) (IOEnv (Env TcGblEnv TcLclEnv) ()
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
            String -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a. HasCallStack => String -> a
panic (String
"GHC.Tc.Module.checkHiBootIface: Cannot handle family " String -> String -> String
forall a. [a] -> [a] -> [a]
++
                   String
"instances in boot files yet...")
            -- FIXME: Why?  The actual comparison is not hard, but what would
            --        be the equivalent to the dfun bindings returned for class
            --        instances?  We can't easily equate tycons...

                -- Check instance declarations
                -- and generate an impedance-matching binding
        ; [(Var, Var)]
dfun_prs <- (Var -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var)))
-> [Var] -> TcM [(Var, Var)]
forall (m :: * -> *) a b.
Applicative m =>
(a -> m (Maybe b)) -> [a] -> m [b]
mapMaybeM Var -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
check_cls_inst [Var]
boot_dfuns

        ; IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM

        ; [(Var, Var)] -> TcM [(Var, Var)]
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ([(Var, Var)]
fld_prs [(Var, Var)] -> [(Var, Var)] -> [(Var, Var)]
forall a. [a] -> [a] -> [a]
++ [(Var, Var)]
dfun_prs) }

  where
    boot_dfun_names :: [Name]
boot_dfun_names = (Var -> Name) -> [Var] -> [Name]
forall a b. (a -> b) -> [a] -> [b]
map Var -> Name
idName [Var]
boot_dfuns
    boot_dfuns :: [Var]
boot_dfuns      = (Var -> Bool) -> [Var] -> [Var]
forall a. (a -> Bool) -> [a] -> [a]
filter Var -> Bool
isDFunId ([Var] -> [Var]) -> [Var] -> [Var]
forall a b. (a -> b) -> a -> b
$ TypeEnv -> [Var]
typeEnvIds TypeEnv
boot_type_env
       -- NB: boot_dfuns is /not/ defined thus: map instanceDFunId md_insts
       --     We don't want to look at md_insts!
       --     Why not?  See Note [DFun knot-tying]

    check_export :: GlobalRdrEnv
-> AvailInfo -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
check_export GlobalRdrEnv
gre_env AvailInfo
boot_avail     -- boot_avail is exported by the boot iface
      | Name
name Name -> [Name] -> Bool
forall a. Eq a => a -> [a] -> Bool
forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [Name]
boot_dfun_names
      = Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe (Var, Var)
forall a. Maybe a
Nothing

        -- Check that the actual module exports the same thing
      | Name
missing_name:[Name]
_ <- [Name]
missing_names
      = -- Lookup might have failed because the hs-boot file defines a variable
        -- that is implemented in the hs file as a record selector, which
        -- lives in a different namespace.
        --
        -- See Note [Record field impedance matching].
        let missing_occ :: OccName
missing_occ = Name -> OccName
nameOccName Name
missing_name
            mb_ok :: GlobalRdrElt -> Maybe (GlobalRdrElt, Maybe Id)
            mb_ok :: GlobalRdrElt -> Maybe (GlobalRdrElt, Maybe Var)
mb_ok GlobalRdrElt
gre
              -- Ensure that this GRE refers to an Id that is exported.
              | Maybe AvailInfo -> Bool
forall a. Maybe a -> Bool
isNothing (Maybe AvailInfo -> Bool) -> Maybe AvailInfo -> Bool
forall a b. (a -> b) -> a -> b
$ NameEnv AvailInfo -> Name -> Maybe AvailInfo
forall a. NameEnv a -> Name -> Maybe a
lookupNameEnv NameEnv AvailInfo
local_export_env (GlobalRdrElt -> Name
forall info. GlobalRdrEltX info -> Name
greName GlobalRdrElt
gre)
              = Maybe (GlobalRdrElt, Maybe Var)
forall a. Maybe a
Nothing
              -- We locally define the field: create an impedance-matching
              -- binding for the variable.
              | Just (AnId Var
id) <- TypeEnv -> Name -> Maybe TyThing
lookupTypeEnv TypeEnv
local_type_env (GlobalRdrElt -> Name
forall info. GlobalRdrEltX info -> Name
greName GlobalRdrElt
gre)
              = (GlobalRdrElt, Maybe Var) -> Maybe (GlobalRdrElt, Maybe Var)
forall a. a -> Maybe a
Just (GlobalRdrElt
gre, Var -> Maybe Var
forall a. a -> Maybe a
Just Var
id)
              -- We are re-exporting the field but not the variable: not a problem,
              -- as per [Wrinkle: exports] in Note [Record field impedance matching].
              | Bool
otherwise
              = (GlobalRdrElt, Maybe Var) -> Maybe (GlobalRdrElt, Maybe Var)
forall a. a -> Maybe a
Just (GlobalRdrElt
gre, Maybe Var
forall a. Maybe a
Nothing)
            matching_flds :: [GlobalRdrElt]
matching_flds
              | OccName -> Bool
isVarOcc OccName
missing_occ -- (This only applies to variables.)
              = GlobalRdrEnv -> LookupGRE GREInfo -> [GlobalRdrElt]
forall info.
GlobalRdrEnvX info -> LookupGRE info -> [GlobalRdrEltX info]
lookupGRE GlobalRdrEnv
gre_env (LookupGRE GREInfo -> [GlobalRdrElt])
-> LookupGRE GREInfo -> [GlobalRdrElt]
forall a b. (a -> b) -> a -> b
$
                OccName -> WhichGREs GREInfo -> LookupGRE GREInfo
forall info. OccName -> WhichGREs info -> LookupGRE info
LookupOccName OccName
missing_occ (FieldsOrSelectors -> WhichGREs GREInfo
RelevantGREsFOS FieldsOrSelectors
WantField)
              | Bool
otherwise
              = [] -- BootFldReexport T18999_NoDisambiguateRecordFields T16745A

        in case (GlobalRdrElt -> Maybe (GlobalRdrElt, Maybe Var))
-> [GlobalRdrElt] -> [(GlobalRdrElt, Maybe Var)]
forall a b. (a -> Maybe b) -> [a] -> [b]
mapMaybe GlobalRdrElt -> Maybe (GlobalRdrElt, Maybe Var)
mb_ok ([GlobalRdrElt] -> [(GlobalRdrElt, Maybe Var)])
-> [GlobalRdrElt] -> [(GlobalRdrElt, Maybe Var)]
forall a b. (a -> b) -> a -> b
$ [GlobalRdrElt]
matching_flds of

          -- At least 2 matches: report an ambiguity error.
          (GlobalRdrElt
gre1,Maybe Var
_):(GlobalRdrElt
gre2,Maybe Var
_):[(GlobalRdrElt, Maybe Var)]
gres_ids -> do
           SrcSpan -> TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErrAt (Name -> SrcSpan
nameSrcSpan Name
missing_name) (TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
             GlobalRdrEnv -> RdrName -> NonEmpty GlobalRdrElt -> TcRnMessage
mkNameClashErr GlobalRdrEnv
gre_env (Name -> RdrName
nameRdrName Name
missing_name)
               (GlobalRdrElt
gre1 GlobalRdrElt -> [GlobalRdrElt] -> NonEmpty GlobalRdrElt
forall a. a -> [a] -> NonEmpty a
NE.:| GlobalRdrElt
gre2 GlobalRdrElt -> [GlobalRdrElt] -> [GlobalRdrElt]
forall a. a -> [a] -> [a]
: ((GlobalRdrElt, Maybe Var) -> GlobalRdrElt)
-> [(GlobalRdrElt, Maybe Var)] -> [GlobalRdrElt]
forall a b. (a -> b) -> [a] -> [b]
map (GlobalRdrElt, Maybe Var) -> GlobalRdrElt
forall a b. (a, b) -> a
fst [(GlobalRdrElt, Maybe Var)]
gres_ids)
           Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe (Var, Var)
forall a. Maybe a
Nothing

          -- Single match: resolve the issue.
          [(GlobalRdrElt
_,Maybe Var
mb_fld_id)] ->
            -- See Note [Record field impedance matching].
            Maybe Var
-> (Var -> IOEnv (Env TcGblEnv TcLclEnv) (Var, Var))
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
t a -> (a -> f b) -> f (t b)
for Maybe Var
mb_fld_id ((Var -> IOEnv (Env TcGblEnv TcLclEnv) (Var, Var))
 -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var)))
-> (Var -> IOEnv (Env TcGblEnv TcLclEnv) (Var, Var))
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a b. (a -> b) -> a -> b
$ \ Var
fld_id -> do
              let local_boot_var :: Var
local_boot_var =
                    Name -> Type -> Var
Id.mkExportedVanillaId Name
missing_name (Var -> Type
idType Var
fld_id)
              (Var, Var) -> IOEnv (Env TcGblEnv TcLclEnv) (Var, Var)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (Var
local_boot_var, Var
fld_id)

          -- Otherwise: report that the hs file does not export something
          -- that the hs-boot file exports.
          [] -> do
           SrcSpan -> TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErrAt (Name -> SrcSpan
nameSrcSpan Name
missing_name)
             (HsBootOrSig -> Name -> MissingBootThing -> TcRnMessage
missingBootThing HsBootOrSig
HsBoot Name
missing_name MissingBootThing
MissingBootExport)
           Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe (Var, Var)
forall a. Maybe a
Nothing

        -- If the boot module does not *define* the thing, we are done
        -- (it simply re-exports it, and names match, so nothing further to do)
      | Maybe TyThing -> Bool
forall a. Maybe a -> Bool
isNothing Maybe TyThing
mb_boot_thing
      = Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe (Var, Var)
forall a. Maybe a
Nothing

        -- Check that the actual module also defines the thing, and
        -- then compare the definitions
      | Just TyThing
real_thing <- TypeEnv -> Name -> Maybe TyThing
lookupTypeEnv TypeEnv
local_type_env Name
name,
        Just TyThing
boot_thing <- Maybe TyThing
mb_boot_thing
      = do HsBootOrSig
-> TyThing -> TyThing -> IOEnv (Env TcGblEnv TcLclEnv) ()
checkBootDeclM HsBootOrSig
HsBoot TyThing
boot_thing TyThing
real_thing
           Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe (Var, Var)
forall a. Maybe a
Nothing

      | Bool
otherwise
      = do TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErrTc (HsBootOrSig -> Name -> MissingBootThing -> TcRnMessage
missingBootThing HsBootOrSig
HsBoot Name
name MissingBootThing
MissingBootDefinition)
           Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe (Var, Var)
forall a. Maybe a
Nothing
      where
        name :: Name
name          = AvailInfo -> Name
availName AvailInfo
boot_avail
        mb_boot_thing :: Maybe TyThing
mb_boot_thing = TypeEnv -> Name -> Maybe TyThing
lookupTypeEnv TypeEnv
boot_type_env Name
name
        missing_names :: [Name]
missing_names = case NameEnv AvailInfo -> Name -> Maybe AvailInfo
forall a. NameEnv a -> Name -> Maybe a
lookupNameEnv NameEnv AvailInfo
local_export_env Name
name of
                          Maybe AvailInfo
Nothing    -> [Name
name]
                          Just AvailInfo
avail -> AvailInfo -> [Name]
availNames AvailInfo
boot_avail
                            [Name] -> [Name] -> [Name]
forall a. Ord a => [a] -> [a] -> [a]
`minusList` AvailInfo -> [Name]
availNames AvailInfo
avail

    local_export_env :: NameEnv AvailInfo
    local_export_env :: NameEnv AvailInfo
local_export_env = [AvailInfo] -> NameEnv AvailInfo
availsToNameEnv [AvailInfo]
local_exports

    check_cls_inst :: DFunId -> TcM (Maybe (Id,Id))
        -- Returns a pair of the boot dfun in terms of the equivalent
        -- real dfun. Delicate (like checkBootDecl) because it depends
        -- on the types lining up precisely even to the ordering of
        -- the type variables in the foralls.
    check_cls_inst :: Var -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
check_cls_inst Var
boot_dfun
      | (Var
real_dfun : [Var]
_) <- Var -> [Var]
find_real_dfun Var
boot_dfun
      , let dfun_name :: Name
dfun_name = Var -> Name
idName Var
boot_dfun
            local_boot_dfun :: Var
local_boot_dfun = Name -> Type -> Var
Id.mkExportedVanillaId Name
dfun_name (Var -> Type
idType Var
real_dfun)
      = Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (Maybe (Var, Var)
 -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var)))
-> Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a b. (a -> b) -> a -> b
$ (Var, Var) -> Maybe (Var, Var)
forall a. a -> Maybe a
Just (Var
local_boot_dfun, Var
real_dfun)
          -- Two tricky points here:
          --
          --  * The local_boot_fun should have a Name from the /boot-file/,
          --    but type from the dfun defined in /this module/.
          --    That ensures that the TyCon etc inside the type are
          --    the ones defined in this module, not the ones gotten
          --    from the hi-boot file, which may have a lot less info
          --    (#8743, comment:10).
          --
          --  * The DFunIds from boot_details are /GlobalIds/, because
          --    they come from typechecking M.hi-boot.
          --    But all bindings in this module should be for /LocalIds/,
          --    otherwise dependency analysis fails (#16038). This
          --    is another reason for using mkExportedVanillaId, rather
          --    that modifying boot_dfun, to make local_boot_fun.
          --
          -- See Note [DFun impedance matching].

      | Bool
otherwise
      = SrcSpan
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan (Name -> SrcSpan
nameSrcSpan (Var -> Name
forall a. NamedThing a => a -> Name
getName Var
boot_dfun)) (IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
 -> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var)))
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a b. (a -> b) -> a -> b
$
        do { String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"check_cls_inst" (SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat
                [ String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"local_insts"  SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+>
                     [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat ((ClsInst -> SDoc) -> [ClsInst] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (Type -> SDoc
forall a. Outputable a => a -> SDoc
ppr (Type -> SDoc) -> (ClsInst -> Type) -> ClsInst -> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Var -> Type
idType (Var -> Type) -> (ClsInst -> Var) -> ClsInst -> Type
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ClsInst -> Var
instanceDFunId) [ClsInst]
local_insts)
                , String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"boot_dfun_ty" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> Type -> SDoc
forall a. Outputable a => a -> SDoc
ppr (Var -> Type
idType Var
boot_dfun) ]

           ; TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErrTc (TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ HsBootOrSig -> BootMismatch -> TcRnMessage
TcRnBootMismatch HsBootOrSig
HsBoot
                      (BootMismatch -> TcRnMessage) -> BootMismatch -> TcRnMessage
forall a b. (a -> b) -> a -> b
$ Var -> BootMismatch
MissingBootInstance Var
boot_dfun
           ; Maybe (Var, Var)
-> IOEnv (Env TcGblEnv TcLclEnv) (Maybe (Var, Var))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe (Var, Var)
forall a. Maybe a
Nothing }

    find_real_dfun :: DFunId -> [DFunId]
    find_real_dfun :: Var -> [Var]
find_real_dfun Var
boot_dfun
       = [Var
dfun | ClsInst
inst <- [ClsInst]
local_insts
               , let dfun :: Var
dfun = ClsInst -> Var
instanceDFunId ClsInst
inst
               , Var -> Type
idType Var
dfun Type -> Type -> Bool
`eqType` Type
boot_dfun_ty ]
       where
          boot_dfun_ty :: Type
boot_dfun_ty   = Var -> Type
idType Var
boot_dfun


-- In general, to perform these checks we have to
-- compare the TyThing from the .hi-boot file to the TyThing
-- in the current source file.  We must be careful to allow alpha-renaming
-- where appropriate, and also the boot declaration is allowed to omit
-- constructors and class methods.
--
-- See rnfail055 for a good test of this stuff.

-- | Compares two things for equivalence between boot-file and normal code,
-- reporting an error if they don't match up.
checkBootDeclM :: HsBootOrSig
               -> TyThing -- ^ boot thing
               -> TyThing -- ^ real thing
               -> TcM ()
checkBootDeclM :: HsBootOrSig
-> TyThing -> TyThing -> IOEnv (Env TcGblEnv TcLclEnv) ()
checkBootDeclM HsBootOrSig
boot_or_sig TyThing
boot_thing TyThing
real_thing
  = [BootMismatchWhat]
-> (BootMismatchWhat -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (t :: * -> *) (f :: * -> *) a b.
(Foldable t, Applicative f) =>
t a -> (a -> f b) -> f ()
for_ [BootMismatchWhat]
boot_errs ((BootMismatchWhat -> IOEnv (Env TcGblEnv TcLclEnv) ())
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> (BootMismatchWhat -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ \ BootMismatchWhat
boot_err ->
      SrcSpan -> TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErrAt SrcSpan
span (TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
        HsBootOrSig -> BootMismatch -> TcRnMessage
TcRnBootMismatch HsBootOrSig
boot_or_sig (BootMismatch -> TcRnMessage) -> BootMismatch -> TcRnMessage
forall a b. (a -> b) -> a -> b
$
        TyThing -> TyThing -> BootMismatchWhat -> BootMismatch
BootMismatch TyThing
boot_thing TyThing
real_thing BootMismatchWhat
boot_err
  where
    boot_errs :: [BootMismatchWhat]
boot_errs = Writer [BootMismatchWhat] () -> [BootMismatchWhat]
forall w a. Monoid w => Writer w a -> w
execWriter (Writer [BootMismatchWhat] () -> [BootMismatchWhat])
-> Writer [BootMismatchWhat] () -> [BootMismatchWhat]
forall a b. (a -> b) -> a -> b
$ HsBootOrSig -> TyThing -> TyThing -> Writer [BootMismatchWhat] ()
checkBootDecl HsBootOrSig
boot_or_sig TyThing
boot_thing TyThing
real_thing

    -- Here we use the span of the boot thing or, if it doesn't have a sensible
    -- span, that of the real thing,
    span :: SrcSpan
span
      | let span :: SrcSpan
span = Name -> SrcSpan
nameSrcSpan (TyThing -> Name
forall a. NamedThing a => a -> Name
getName TyThing
boot_thing)
      , SrcSpan -> Bool
isGoodSrcSpan SrcSpan
span
      = SrcSpan
span
      | Bool
otherwise
      = Name -> SrcSpan
nameSrcSpan (TyThing -> Name
forall a. NamedThing a => a -> Name
getName TyThing
real_thing)

-- | Writer monad for accumulating errors when comparing an hs-boot or
-- signature file with its implementing module.
type BootErrsM err = Writer [err] ()

-- | If the test in the first parameter is True, succeed.
-- Otherwise, record the given error.
check :: Bool -> err -> BootErrsM err
check :: forall err. Bool -> err -> BootErrsM err
check Bool
True  err
_   = BootErrsM err
forall err. BootErrsM err
checkSuccess
check Bool
False err
err = err -> BootErrsM err
forall err. err -> BootErrsM err
bootErr err
err

-- | Record an error.
bootErr :: err -> BootErrsM err
bootErr :: forall err. err -> BootErrsM err
bootErr err
err = [err] -> WriterT [err] Identity ()
forall w (m :: * -> *). (Monoid w, Monad m) => w -> WriterT w m ()
tell [err
err]

-- | A convenience synonym for a lack of errors, for @checkBootDecl@ and friends.
checkSuccess :: BootErrsM err
checkSuccess :: forall err. BootErrsM err
checkSuccess = () -> WriterT [err] Identity ()
forall a. a -> WriterT [err] Identity a
forall (m :: * -> *) a. Monad m => a -> m a
return ()

-- | Map over the error types in an error-accumulating computation.
embedErrs :: (err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
embedErrs :: forall err1 err2.
(err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
embedErrs err1 -> err2
f = (((), [err1]) -> ((), [err2]))
-> Writer [err1] () -> Writer [err2] ()
forall w w' a b.
(Monoid w, Monoid w') =>
((a, w) -> (b, w')) -> Writer w a -> Writer w' b
mapWriter (([err1] -> [err2]) -> ((), [err1]) -> ((), [err2])
forall b c d. (b -> c) -> (d, b) -> (d, c)
forall (a :: * -> * -> *) b c d.
Arrow a =>
a b c -> a (d, b) (d, c)
second ((err1 -> err2) -> [err1] -> [err2]
forall a b. (a -> b) -> [a] -> [b]
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap err1 -> err2
f))

-- | Wrap up a list of errors into a single message.
wrapErrs :: (NE.NonEmpty err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
wrapErrs :: forall err1 err2.
(NonEmpty err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
wrapErrs NonEmpty err1 -> err2
f BootErrsM err1
w =
  case BootErrsM err1 -> [err1]
forall w a. Monoid w => Writer w a -> w
execWriter BootErrsM err1
w of
    []         -> BootErrsM err2
forall err. BootErrsM err
checkSuccess
    err1
err : [err1]
errs -> err2 -> BootErrsM err2
forall err. err -> BootErrsM err
bootErr (NonEmpty err1 -> err2
f (NonEmpty err1 -> err2) -> NonEmpty err1 -> err2
forall a b. (a -> b) -> a -> b
$ err1
err err1 -> [err1] -> NonEmpty err1
forall a. a -> [a] -> NonEmpty a
:| [err1]
errs)

-- | Compares the two things for equivalence between boot-file and normal
-- code. Returns @Nothing@ on success or @Just "some helpful info for user"@
-- failure. If the difference will be apparent to the user, @Just empty@ is
-- perfectly suitable.
checkBootDecl :: HsBootOrSig -> TyThing -> TyThing -> BootErrsM BootMismatchWhat

checkBootDecl :: HsBootOrSig -> TyThing -> TyThing -> Writer [BootMismatchWhat] ()
checkBootDecl HsBootOrSig
_ (AnId Var
id1) (AnId Var
id2)
  = Bool
-> Writer [BootMismatchWhat] () -> Writer [BootMismatchWhat] ()
forall a. HasCallStack => Bool -> a -> a
assert (Var
id1 Var -> Var -> Bool
forall a. Eq a => a -> a -> Bool
== Var
id2) (Writer [BootMismatchWhat] () -> Writer [BootMismatchWhat] ())
-> Writer [BootMismatchWhat] () -> Writer [BootMismatchWhat] ()
forall a b. (a -> b) -> a -> b
$
    Bool -> BootMismatchWhat -> Writer [BootMismatchWhat] ()
forall err. Bool -> err -> BootErrsM err
check (Var -> Type
idType Var
id1 Type -> Type -> Bool
`eqType` Var -> Type
idType Var
id2)
          (Var -> Var -> BootMismatchWhat
BootMismatchedIdTypes Var
id1 Var
id2)

checkBootDecl HsBootOrSig
boot_or_sig (ATyCon TyCon
tc1) (ATyCon TyCon
tc2)
  = (NonEmpty BootTyConMismatch -> BootMismatchWhat)
-> BootErrsM BootTyConMismatch -> Writer [BootMismatchWhat] ()
forall err1 err2.
(NonEmpty err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
wrapErrs (TyCon -> TyCon -> NonEmpty BootTyConMismatch -> BootMismatchWhat
BootMismatchedTyCons TyCon
tc1 TyCon
tc2) (BootErrsM BootTyConMismatch -> Writer [BootMismatchWhat] ())
-> BootErrsM BootTyConMismatch -> Writer [BootMismatchWhat] ()
forall a b. (a -> b) -> a -> b
$
    HsBootOrSig -> TyCon -> TyCon -> BootErrsM BootTyConMismatch
checkBootTyCon HsBootOrSig
boot_or_sig TyCon
tc1 TyCon
tc2

checkBootDecl HsBootOrSig
_ TyThing
t1 TyThing
t2
  = String -> SDoc -> Writer [BootMismatchWhat] ()
forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"checkBootDecl" (TyThing -> SDoc
forall a. Outputable a => a -> SDoc
ppr TyThing
t1 SDoc -> SDoc -> SDoc
forall doc. IsDoc doc => doc -> doc -> doc
$$ TyThing -> SDoc
forall a. Outputable a => a -> SDoc
ppr TyThing
t2)

-- | Run the check provided for every pair of elements in the lists.
--
-- Records an error:
--
--  - when any two items at the same position in the two lists don't match
--    according to the given function,
--  - when the lists are of different lengths.
checkListBy :: (a -> a -> BootErrsM err) -> [a] -> [a]
            -> (BootListMismatches a err -> err2)
            -> BootErrsM err2
checkListBy :: forall a err err2.
(a -> a -> BootErrsM err)
-> [a]
-> [a]
-> (BootListMismatches a err -> err2)
-> BootErrsM err2
checkListBy a -> a -> BootErrsM err
check_fun [a]
as [a]
bs BootListMismatches a err -> err2
mk_err = (BootListMismatches a err -> err2)
-> BootErrsM (BootListMismatch a err) -> BootErrsM err2
forall err1 err2.
(NonEmpty err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
wrapErrs BootListMismatches a err -> err2
mk_err (BootErrsM (BootListMismatch a err) -> BootErrsM err2)
-> BootErrsM (BootListMismatch a err) -> BootErrsM err2
forall a b. (a -> b) -> a -> b
$ Arity -> [a] -> [a] -> BootErrsM (BootListMismatch a err)
go Arity
1 [a]
as [a]
bs
  where
    go :: Arity -> [a] -> [a] -> BootErrsM (BootListMismatch a err)
go Arity
_  [] [] = BootErrsM (BootListMismatch a err)
forall err. BootErrsM err
checkSuccess
    go !Arity
i (a
x:[a]
xs) (a
y:[a]
ys) =
      do { (err -> BootListMismatch a err)
-> BootErrsM err -> BootErrsM (BootListMismatch a err)
forall err1 err2.
(err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
embedErrs (Arity -> a -> a -> err -> BootListMismatch a err
forall item err.
Arity -> item -> item -> err -> BootListMismatch item err
MismatchedThing Arity
i a
x a
y) (BootErrsM err -> BootErrsM (BootListMismatch a err))
-> BootErrsM err -> BootErrsM (BootListMismatch a err)
forall a b. (a -> b) -> a -> b
$ a -> a -> BootErrsM err
check_fun a
x a
y
         ; Arity -> [a] -> [a] -> BootErrsM (BootListMismatch a err)
go (Arity
iArity -> Arity -> Arity
forall a. Num a => a -> a -> a
+Arity
1) [a]
xs [a]
ys }
    go Arity
_  [a]
_  [a]
_ = BootListMismatch a err -> BootErrsM (BootListMismatch a err)
forall err. err -> BootErrsM err
bootErr BootListMismatch a err
forall item err. BootListMismatch item err
MismatchedLength

----------------
checkBootTyCon :: HsBootOrSig -> TyCon -> TyCon -> BootErrsM BootTyConMismatch
checkBootTyCon :: HsBootOrSig -> TyCon -> TyCon -> BootErrsM BootTyConMismatch
checkBootTyCon HsBootOrSig
boot_or_sig TyCon
tc1 TyCon
tc2
  | Bool -> Bool
not (Type -> Type -> Bool
eqType (TyCon -> Type
tyConKind TyCon
tc1) (TyCon -> Type
tyConKind TyCon
tc2))
  -- First off, check the kind
  = BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. err -> BootErrsM err
bootErr BootTyConMismatch
TyConKindMismatch

  | Just Class
c1 <- TyCon -> Maybe Class
tyConClass_maybe TyCon
tc1
  , Just Class
c2 <- TyCon -> Maybe Class
tyConClass_maybe TyCon
tc2
  , let ([Var]
clas_tvs1, [FunDep Var]
clas_fds1, [Type]
sc_theta1, [Var]
_, [ClassATItem]
ats1, [ClassOpItem]
op_stuff1)
          = Class
-> ([Var], [FunDep Var], [Type], [Var], [ClassATItem],
    [ClassOpItem])
classExtraBigSig Class
c1
        ([Var]
clas_tvs2, [FunDep Var]
clas_fds2, [Type]
sc_theta2, [Var]
_, [ClassATItem]
ats2, [ClassOpItem]
op_stuff2)
          = Class
-> ([Var], [FunDep Var], [Type], [Var], [ClassATItem],
    [ClassOpItem])
classExtraBigSig Class
c2
  , Just RnEnv2
env <- RnEnv2 -> [Var] -> [Var] -> Maybe RnEnv2
eqVarBndrs RnEnv2
emptyRnEnv2 [Var]
clas_tvs1 [Var]
clas_tvs2
  = do { BootErrsM BootTyConMismatch
check_roles
       ; (BootClassMismatch -> BootTyConMismatch)
-> BootErrsM BootClassMismatch -> BootErrsM BootTyConMismatch
forall err1 err2.
(err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
embedErrs (Class -> Class -> BootClassMismatch -> BootTyConMismatch
TyConMismatchedClasses Class
c1 Class
c2) (BootErrsM BootClassMismatch -> BootErrsM BootTyConMismatch)
-> BootErrsM BootClassMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
    do { -- Checks kind of class
       ; Bool -> BootClassMismatch -> BootErrsM BootClassMismatch
forall err. Bool -> err -> BootErrsM err
check ((FunDep Var -> FunDep Var -> Bool)
-> [FunDep Var] -> [FunDep Var] -> Bool
forall a b. (a -> b -> Bool) -> [a] -> [b] -> Bool
forall (f :: * -> *) a b.
Eq1 f =>
(a -> b -> Bool) -> f a -> f b -> Bool
liftEq (RnEnv2 -> FunDep Var -> FunDep Var -> Bool
eqFD RnEnv2
env) [FunDep Var]
clas_fds1 [FunDep Var]
clas_fds2)
           BootClassMismatch
MismatchedFunDeps
       ; Bool -> BootErrsM BootClassMismatch -> BootErrsM BootClassMismatch
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (TyCon -> Bool
isAbstractTyCon TyCon
tc1) (BootErrsM BootClassMismatch -> BootErrsM BootClassMismatch)
-> BootErrsM BootClassMismatch -> BootErrsM BootClassMismatch
forall a b. (a -> b) -> a -> b
$
    do { Bool -> BootClassMismatch -> BootErrsM BootClassMismatch
forall err. Bool -> err -> BootErrsM err
check ((Type -> Type -> Bool) -> [Type] -> [Type] -> Bool
forall a b. (a -> b -> Bool) -> [a] -> [b] -> Bool
forall (f :: * -> *) a b.
Eq1 f =>
(a -> b -> Bool) -> f a -> f b -> Bool
liftEq (RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env) [Type]
sc_theta1 [Type]
sc_theta2)
           BootClassMismatch
MismatchedSuperclasses
       ; (ClassOpItem -> ClassOpItem -> BootErrsM BootMethodMismatch)
-> [ClassOpItem]
-> [ClassOpItem]
-> (BootListMismatches ClassOpItem BootMethodMismatch
    -> BootClassMismatch)
-> BootErrsM BootClassMismatch
forall a err err2.
(a -> a -> BootErrsM err)
-> [a]
-> [a]
-> (BootListMismatches a err -> err2)
-> BootErrsM err2
checkListBy (RnEnv2
-> HsBootOrSig
-> ClassOpItem
-> ClassOpItem
-> BootErrsM BootMethodMismatch
compatClassOp RnEnv2
env HsBootOrSig
boot_or_sig) [ClassOpItem]
op_stuff1 [ClassOpItem]
op_stuff2
           BootListMismatches ClassOpItem BootMethodMismatch
-> BootClassMismatch
MismatchedMethods
       ; (ClassATItem -> ClassATItem -> BootErrsM BootATMismatch)
-> [ClassATItem]
-> [ClassATItem]
-> (BootListMismatches ClassATItem BootATMismatch
    -> BootClassMismatch)
-> BootErrsM BootClassMismatch
forall a err err2.
(a -> a -> BootErrsM err)
-> [a]
-> [a]
-> (BootListMismatches a err -> err2)
-> BootErrsM err2
checkListBy (RnEnv2
-> HsBootOrSig
-> ClassATItem
-> ClassATItem
-> BootErrsM BootATMismatch
compatAT RnEnv2
env HsBootOrSig
boot_or_sig) [ClassATItem]
ats1 [ClassATItem]
ats2
           BootListMismatches ClassATItem BootATMismatch -> BootClassMismatch
MismatchedATs
       ; Bool -> BootClassMismatch -> BootErrsM BootClassMismatch
forall err. Bool -> err -> BootErrsM err
check (Class -> ClassMinimalDef
classMinimalDef Class
c1 ClassMinimalDef -> ClassMinimalDef -> Bool
forall a.
Uniquable a =>
BooleanFormula a -> BooleanFormula a -> Bool
`BF.implies` Class -> ClassMinimalDef
classMinimalDef Class
c2)
           BootClassMismatch
MismatchedMinimalPragmas
       } } }

  | Just Type
syn_rhs1 <- TyCon -> Maybe Type
synTyConRhs_maybe TyCon
tc1
  , Just Type
syn_rhs2 <- TyCon -> Maybe Type
synTyConRhs_maybe TyCon
tc2
  , Just RnEnv2
env <- RnEnv2 -> [Var] -> [Var] -> Maybe RnEnv2
eqVarBndrs RnEnv2
emptyRnEnv2 (TyCon -> [Var]
tyConTyVars TyCon
tc1) (TyCon -> [Var]
tyConTyVars TyCon
tc2)
  = Bool -> BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a. HasCallStack => Bool -> a -> a
assert (TyCon
tc1 TyCon -> TyCon -> Bool
forall a. Eq a => a -> a -> Bool
== TyCon
tc2) (BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
  do { BootErrsM BootTyConMismatch
check_roles
     ; Bool -> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. Bool -> err -> BootErrsM err
check (RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env Type
syn_rhs1 Type
syn_rhs2) (BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
        Type -> Type -> BootTyConMismatch
TyConSynonymMismatch Type
syn_rhs1 Type
syn_rhs2 }

  -- This allows abstract 'data T a' to be implemented using 'type T = ...'
  -- and abstract 'class K a' to be implement using 'type K = ...'
  -- See Note [Synonyms implement abstract data]
  | HsBootOrSig
Hsig <- HsBootOrSig
boot_or_sig -- don't support for hs-boot yet
  , TyCon -> Bool
isAbstractTyCon TyCon
tc1
  , Just ([Var]
tvs, Type
ty) <- TyCon -> Maybe ([Var], Type)
synTyConDefn_maybe TyCon
tc2
  = TyCon -> TyCon -> [Var] -> Type -> BootErrsM BootTyConMismatch
checkSynAbsData TyCon
tc1 TyCon
tc2 [Var]
tvs Type
ty

  | Just FamTyConFlav
fam_flav1 <- TyCon -> Maybe FamTyConFlav
famTyConFlav_maybe TyCon
tc1
  , Just FamTyConFlav
fam_flav2 <- TyCon -> Maybe FamTyConFlav
famTyConFlav_maybe TyCon
tc2
  = Bool -> BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a. HasCallStack => Bool -> a -> a
assert (TyCon
tc1 TyCon -> TyCon -> Bool
forall a. Eq a => a -> a -> Bool
== TyCon
tc2) (BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
    do { let injInfo1 :: Injectivity
injInfo1 = TyCon -> Injectivity
tyConInjectivityInfo TyCon
tc1
             injInfo2 :: Injectivity
injInfo2 = TyCon -> Injectivity
tyConInjectivityInfo TyCon
tc2
       ; -- check equality of roles, family flavours and injectivity annotations
         -- (NB: Type family roles are always nominal. But the check is
         -- harmless enough.)
       ; BootErrsM BootTyConMismatch
check_roles
       ; FamTyConFlav -> FamTyConFlav -> BootErrsM BootTyConMismatch
compatFamFlav FamTyConFlav
fam_flav1 FamTyConFlav
fam_flav2
       ; Bool -> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. Bool -> err -> BootErrsM err
check (Injectivity
injInfo1 Injectivity -> Injectivity -> Bool
forall a. Eq a => a -> a -> Bool
== Injectivity
injInfo2) BootTyConMismatch
TyConInjectivityMismatch }

  | TyCon -> Bool
isAlgTyCon TyCon
tc1 Bool -> Bool -> Bool
&& TyCon -> Bool
isAlgTyCon TyCon
tc2
  , Just RnEnv2
env <- RnEnv2 -> [Var] -> [Var] -> Maybe RnEnv2
eqVarBndrs RnEnv2
emptyRnEnv2 (TyCon -> [Var]
tyConTyVars TyCon
tc1) (TyCon -> [Var]
tyConTyVars TyCon
tc2)
  = Bool -> BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a. HasCallStack => Bool -> a -> a
assert (TyCon
tc1 TyCon -> TyCon -> Bool
forall a. Eq a => a -> a -> Bool
== TyCon
tc2) (BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
  do { BootErrsM BootTyConMismatch
check_roles
     ; let rhs1 :: AlgTyConRhs
rhs1 = TyCon -> AlgTyConRhs
algTyConRhs TyCon
tc1
           rhs2 :: AlgTyConRhs
rhs2 = TyCon -> AlgTyConRhs
algTyConRhs TyCon
tc2
     ; (BootDataMismatch -> BootTyConMismatch)
-> BootErrsM BootDataMismatch -> BootErrsM BootTyConMismatch
forall err1 err2.
(err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
embedErrs (AlgTyConRhs -> AlgTyConRhs -> BootDataMismatch -> BootTyConMismatch
TyConMismatchedData AlgTyConRhs
rhs1 AlgTyConRhs
rhs2) (BootErrsM BootDataMismatch -> BootErrsM BootTyConMismatch)
-> BootErrsM BootDataMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
  do { Bool -> BootDataMismatch -> BootErrsM BootDataMismatch
forall err. Bool -> err -> BootErrsM err
check ((Type -> Type -> Bool) -> [Type] -> [Type] -> Bool
forall a b. (a -> b -> Bool) -> [a] -> [b] -> Bool
forall (f :: * -> *) a b.
Eq1 f =>
(a -> b -> Bool) -> f a -> f b -> Bool
liftEq (RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env)
                     (TyCon -> [Type]
tyConStupidTheta TyCon
tc1) (TyCon -> [Type]
tyConStupidTheta TyCon
tc2))
                      BootDataMismatch
MismatchedDatatypeContexts
     ; AlgTyConRhs -> AlgTyConRhs -> BootErrsM BootDataMismatch
compatAlgRhs AlgTyConRhs
rhs1 AlgTyConRhs
rhs2 } }

  | Bool
otherwise = BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. err -> BootErrsM err
bootErr BootTyConMismatch
TyConsVeryDifferent
                -- two very different types;
                -- should be obvious to the user what the problem is
  where
    check_roles :: BootErrsM BootTyConMismatch
check_roles = HsBootOrSig -> TyCon -> [Role] -> BootErrsM BootTyConMismatch
checkRoles HsBootOrSig
boot_or_sig TyCon
tc1 (TyCon -> [Role]
tyConRoles TyCon
tc2)


emptyRnEnv2 :: RnEnv2
emptyRnEnv2 :: RnEnv2
emptyRnEnv2 = InScopeSet -> RnEnv2
mkRnEnv2 InScopeSet
emptyInScopeSet

-- | Check that two class methods have compatible type signatures.
compatClassOp :: RnEnv2 -> HsBootOrSig -> ClassOpItem -> ClassOpItem -> BootErrsM BootMethodMismatch
compatClassOp :: RnEnv2
-> HsBootOrSig
-> ClassOpItem
-> ClassOpItem
-> BootErrsM BootMethodMismatch
compatClassOp RnEnv2
env HsBootOrSig
boot_or_sig (Var
id1, DefMethInfo
def_meth1) (Var
id2, DefMethInfo
def_meth2)
  = do { Bool -> BootMethodMismatch -> BootErrsM BootMethodMismatch
forall err. Bool -> err -> BootErrsM err
check (Name
name1 Name -> Name -> Bool
forall a. Eq a => a -> a -> Bool
== Name
name2) (BootMethodMismatch -> BootErrsM BootMethodMismatch)
-> BootMethodMismatch -> BootErrsM BootMethodMismatch
forall a b. (a -> b) -> a -> b
$
           BootMethodMismatch
MismatchedMethodNames
       ; Bool -> BootMethodMismatch -> BootErrsM BootMethodMismatch
forall err. Bool -> err -> BootErrsM err
check (RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env Type
op_ty1 Type
op_ty2) (BootMethodMismatch -> BootErrsM BootMethodMismatch)
-> BootMethodMismatch -> BootErrsM BootMethodMismatch
forall a b. (a -> b) -> a -> b
$
           Type -> Type -> BootMethodMismatch
MismatchedMethodTypes Type
op_ty1 Type
op_ty2
       ; case HsBootOrSig
boot_or_sig of
           HsBootOrSig
HsBoot ->
             Bool -> BootMethodMismatch -> BootErrsM BootMethodMismatch
forall err. Bool -> err -> BootErrsM err
check (((Name, DefMethSpec Type) -> (Name, DefMethSpec Type) -> Bool)
-> DefMethInfo -> DefMethInfo -> Bool
forall a b. (a -> b -> Bool) -> Maybe a -> Maybe b -> Bool
forall (f :: * -> *) a b.
Eq1 f =>
(a -> b -> Bool) -> f a -> f b -> Bool
liftEq (Name, DefMethSpec Type) -> (Name, DefMethSpec Type) -> Bool
eqDM DefMethInfo
def_meth1 DefMethInfo
def_meth2) (BootMethodMismatch -> BootErrsM BootMethodMismatch)
-> BootMethodMismatch -> BootErrsM BootMethodMismatch
forall a b. (a -> b) -> a -> b
$
               Bool -> BootMethodMismatch
MismatchedDefaultMethods Bool
False
           HsBootOrSig
Hsig ->
             Bool -> BootMethodMismatch -> BootErrsM BootMethodMismatch
forall err. Bool -> err -> BootErrsM err
check (Type -> DefMethInfo -> DefMethInfo -> Bool
subDM Type
op_ty1 DefMethInfo
def_meth1 DefMethInfo
def_meth2) (BootMethodMismatch -> BootErrsM BootMethodMismatch)
-> BootMethodMismatch -> BootErrsM BootMethodMismatch
forall a b. (a -> b) -> a -> b
$
               Bool -> BootMethodMismatch
MismatchedDefaultMethods Bool
True }
  where
    name1 :: Name
name1 = Var -> Name
idName Var
id1
    name2 :: Name
name2 = Var -> Name
idName Var
id2
    op_ty1 :: Type
op_ty1 = Var -> Type
classMethodTy Var
id1
    op_ty2 :: Type
op_ty2 = Var -> Type
classMethodTy Var
id2

    eqDM :: (Name, DefMethSpec Type) -> (Name, DefMethSpec Type) -> Bool
eqDM (Name
_, DefMethSpec Type
VanillaDM)    (Name
_, DefMethSpec Type
VanillaDM)    = Bool
True
    eqDM (Name
_, GenericDM Type
t1) (Name
_, GenericDM Type
t2) = RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env Type
t1 Type
t2
    eqDM (Name, DefMethSpec Type)
_ (Name, DefMethSpec Type)
_ = Bool
False

    -- NB: first argument is from hsig, second is from real impl.
    -- Order of pattern matching matters.
    subDM :: Type -> DefMethInfo -> DefMethInfo -> Bool
subDM Type
_ DefMethInfo
Nothing DefMethInfo
_ = Bool
True
    subDM Type
_ DefMethInfo
_ DefMethInfo
Nothing = Bool
False

    -- If the hsig wrote:
    --
    --   f :: a -> a
    --   default f :: a -> a
    --
    -- this should be validly implementable using an old-fashioned
    -- vanilla default method.
    subDM Type
t1 (Just (Name
_, GenericDM Type
gdm_t1)) (Just (Name
_, DefMethSpec Type
VanillaDM))
     = Type -> Type -> Bool
eqType Type
t1 Type
gdm_t1   -- Take care (#22476).  Both t1 and gdm_t1 come
                             -- from tc1, so use eqType, and /not/ eqTypeX

    -- This case can occur when merging signatures
    subDM Type
t1 (Just (Name
_, DefMethSpec Type
VanillaDM)) (Just (Name
_, GenericDM Type
t2))
     = RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env Type
t1 Type
t2

    subDM Type
_ (Just (Name
_, DefMethSpec Type
VanillaDM)) (Just (Name
_, DefMethSpec Type
VanillaDM)) = Bool
True
    subDM Type
_ (Just (Name
_, GenericDM Type
t1)) (Just (Name
_, GenericDM Type
t2))
     = RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env Type
t1 Type
t2

-- | Check that two associated types are compatible.
compatAT :: RnEnv2 -> HsBootOrSig -> ClassATItem -> ClassATItem
         -> BootErrsM BootATMismatch
compatAT :: RnEnv2
-> HsBootOrSig
-> ClassATItem
-> ClassATItem
-> BootErrsM BootATMismatch
compatAT RnEnv2
env HsBootOrSig
boot_or_sig (ATI TyCon
tc1 Maybe (Type, TyFamEqnValidityInfo)
def_ats1) (ATI TyCon
tc2 Maybe (Type, TyFamEqnValidityInfo)
def_ats2)
  = do { (BootTyConMismatch -> BootATMismatch)
-> BootErrsM BootTyConMismatch -> BootErrsM BootATMismatch
forall err1 err2.
(err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
embedErrs BootTyConMismatch -> BootATMismatch
MismatchedTyConAT (BootErrsM BootTyConMismatch -> BootErrsM BootATMismatch)
-> BootErrsM BootTyConMismatch -> BootErrsM BootATMismatch
forall a b. (a -> b) -> a -> b
$
           HsBootOrSig -> TyCon -> TyCon -> BootErrsM BootTyConMismatch
checkBootTyCon HsBootOrSig
boot_or_sig TyCon
tc1 TyCon
tc2
       ; Bool -> BootATMismatch -> BootErrsM BootATMismatch
forall err. Bool -> err -> BootErrsM err
check (Maybe (Type, TyFamEqnValidityInfo)
-> Maybe (Type, TyFamEqnValidityInfo) -> Bool
compatATDef Maybe (Type, TyFamEqnValidityInfo)
def_ats1 Maybe (Type, TyFamEqnValidityInfo)
def_ats2)
           BootATMismatch
MismatchedATDefaultType }

  where
    -- Ignore the location of the defaults
    compatATDef :: Maybe (Type, TyFamEqnValidityInfo)
-> Maybe (Type, TyFamEqnValidityInfo) -> Bool
compatATDef Maybe (Type, TyFamEqnValidityInfo)
Nothing             Maybe (Type, TyFamEqnValidityInfo)
Nothing             = Bool
True
    compatATDef (Just (Type
ty1, TyFamEqnValidityInfo
_loc1)) (Just (Type
ty2, TyFamEqnValidityInfo
_loc2)) = RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env Type
ty1 Type
ty2
    compatATDef Maybe (Type, TyFamEqnValidityInfo)
_ Maybe (Type, TyFamEqnValidityInfo)
_ = Bool
False

-- | Check that two functional dependencies are the same.
eqFD :: RnEnv2 -> FunDep TyVar -> FunDep TyVar -> Bool
eqFD :: RnEnv2 -> FunDep Var -> FunDep Var -> Bool
eqFD RnEnv2
env ([Var]
as1,[Var]
bs1) ([Var]
as2,[Var]
bs2) =
  (Type -> Type -> Bool) -> [Type] -> [Type] -> Bool
forall a b. (a -> b -> Bool) -> [a] -> [b] -> Bool
forall (f :: * -> *) a b.
Eq1 f =>
(a -> b -> Bool) -> f a -> f b -> Bool
liftEq (RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env) ([Var] -> [Type]
mkTyVarTys [Var]
as1) ([Var] -> [Type]
mkTyVarTys [Var]
as2) Bool -> Bool -> Bool
&&
  (Type -> Type -> Bool) -> [Type] -> [Type] -> Bool
forall a b. (a -> b -> Bool) -> [a] -> [b] -> Bool
forall (f :: * -> *) a b.
Eq1 f =>
(a -> b -> Bool) -> f a -> f b -> Bool
liftEq (RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env) ([Var] -> [Type]
mkTyVarTys [Var]
bs1) ([Var] -> [Type]
mkTyVarTys [Var]
bs2)

-- | Check compatibility of two type family flavours.
compatFamFlav :: FamTyConFlav -> FamTyConFlav -> BootErrsM BootTyConMismatch
compatFamFlav :: FamTyConFlav -> FamTyConFlav -> BootErrsM BootTyConMismatch
compatFamFlav FamTyConFlav
OpenSynFamilyTyCon   FamTyConFlav
OpenSynFamilyTyCon
  = BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess
compatFamFlav (DataFamilyTyCon {}) (DataFamilyTyCon {})
  = BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess
compatFamFlav FamTyConFlav
AbstractClosedSynFamilyTyCon FamTyConFlav
AbstractClosedSynFamilyTyCon
  = BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess -- This case only happens for hsig merging.
compatFamFlav FamTyConFlav
AbstractClosedSynFamilyTyCon (ClosedSynFamilyTyCon {})
  = BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess
compatFamFlav (ClosedSynFamilyTyCon {}) FamTyConFlav
AbstractClosedSynFamilyTyCon
  = BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess
compatFamFlav (ClosedSynFamilyTyCon Maybe (CoAxiom Branched)
ax1) (ClosedSynFamilyTyCon Maybe (CoAxiom Branched)
ax2)
  = Maybe (CoAxiom Branched)
-> Maybe (CoAxiom Branched) -> BootErrsM BootTyConMismatch
forall (br :: BranchFlag) (br1 :: BranchFlag).
Maybe (CoAxiom br)
-> Maybe (CoAxiom br1) -> BootErrsM BootTyConMismatch
eqClosedFamilyAx Maybe (CoAxiom Branched)
ax1 Maybe (CoAxiom Branched)
ax2
compatFamFlav (BuiltInSynFamTyCon {}) (BuiltInSynFamTyCon {})
  = BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess
compatFamFlav FamTyConFlav
flav1 FamTyConFlav
flav2
  = BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. err -> BootErrsM err
bootErr (BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$ FamTyConFlav -> FamTyConFlav -> BootTyConMismatch
TyConFlavourMismatch FamTyConFlav
flav1 FamTyConFlav
flav2

-- | Check that two 'AlgTyConRhs's are compatible.
compatAlgRhs :: AlgTyConRhs -> AlgTyConRhs -> BootErrsM BootDataMismatch
compatAlgRhs :: AlgTyConRhs -> AlgTyConRhs -> BootErrsM BootDataMismatch
compatAlgRhs (AbstractTyCon {}) AlgTyConRhs
_rhs2 =
  BootErrsM BootDataMismatch
forall err. BootErrsM err
checkSuccess -- rhs2 is guaranteed to be injective, since it's an AlgTyCon
compatAlgRhs  tc1 :: AlgTyConRhs
tc1@DataTyCon{} tc2 :: AlgTyConRhs
tc2@DataTyCon{} =
  (DataCon -> DataCon -> BootErrsM BootDataConMismatch)
-> [DataCon]
-> [DataCon]
-> (BootListMismatches DataCon BootDataConMismatch
    -> BootDataMismatch)
-> BootErrsM BootDataMismatch
forall a err err2.
(a -> a -> BootErrsM err)
-> [a]
-> [a]
-> (BootListMismatches a err -> err2)
-> BootErrsM err2
checkListBy DataCon -> DataCon -> BootErrsM BootDataConMismatch
compatCon (AlgTyConRhs -> [DataCon]
data_cons AlgTyConRhs
tc1) (AlgTyConRhs -> [DataCon]
data_cons AlgTyConRhs
tc2) BootListMismatches DataCon BootDataConMismatch -> BootDataMismatch
MismatchedConstructors
compatAlgRhs  tc1 :: AlgTyConRhs
tc1@NewTyCon{ data_con :: AlgTyConRhs -> DataCon
data_con = DataCon
dc1 } tc2 :: AlgTyConRhs
tc2@NewTyCon{ data_con :: AlgTyConRhs -> DataCon
data_con = DataCon
dc2 } =
  (BootDataConMismatch -> BootDataMismatch)
-> BootErrsM BootDataConMismatch -> BootErrsM BootDataMismatch
forall err1 err2.
(err1 -> err2) -> BootErrsM err1 -> BootErrsM err2
embedErrs (BootListMismatches DataCon BootDataConMismatch -> BootDataMismatch
MismatchedConstructors (BootListMismatches DataCon BootDataConMismatch
 -> BootDataMismatch)
-> (BootDataConMismatch
    -> BootListMismatches DataCon BootDataConMismatch)
-> BootDataConMismatch
-> BootDataMismatch
forall b c a. (b -> c) -> (a -> b) -> a -> c
. BootListMismatch DataCon BootDataConMismatch
-> BootListMismatches DataCon BootDataConMismatch
forall a. a -> NonEmpty a
NE.singleton (BootListMismatch DataCon BootDataConMismatch
 -> BootListMismatches DataCon BootDataConMismatch)
-> (BootDataConMismatch
    -> BootListMismatch DataCon BootDataConMismatch)
-> BootDataConMismatch
-> BootListMismatches DataCon BootDataConMismatch
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Arity
-> DataCon
-> DataCon
-> BootDataConMismatch
-> BootListMismatch DataCon BootDataConMismatch
forall item err.
Arity -> item -> item -> err -> BootListMismatch item err
MismatchedThing Arity
1 DataCon
dc1 DataCon
dc2) (BootErrsM BootDataConMismatch -> BootErrsM BootDataMismatch)
-> BootErrsM BootDataConMismatch -> BootErrsM BootDataMismatch
forall a b. (a -> b) -> a -> b
$
    DataCon -> DataCon -> BootErrsM BootDataConMismatch
compatCon (AlgTyConRhs -> DataCon
data_con AlgTyConRhs
tc1) (AlgTyConRhs -> DataCon
data_con AlgTyConRhs
tc2)
compatAlgRhs AlgTyConRhs
_ AlgTyConRhs
_ = BootDataMismatch -> BootErrsM BootDataMismatch
forall err. err -> BootErrsM err
bootErr BootDataMismatch
MismatchedNewtypeVsData

-- | Check that two 'DataCon's are compatible.
compatCon :: DataCon -> DataCon -> BootErrsM BootDataConMismatch
compatCon :: DataCon -> DataCon -> BootErrsM BootDataConMismatch
compatCon DataCon
c1 DataCon
c2
  = do { Bool -> BootDataConMismatch -> BootErrsM BootDataConMismatch
forall err. Bool -> err -> BootErrsM err
check (DataCon -> Name
dataConName DataCon
c1 Name -> Name -> Bool
forall a. Eq a => a -> a -> Bool
== DataCon -> Name
dataConName DataCon
c2)
           BootDataConMismatch
MismatchedDataConNames
       ; Bool -> BootDataConMismatch -> BootErrsM BootDataConMismatch
forall err. Bool -> err -> BootErrsM err
check (DataCon -> Bool
dataConIsInfix DataCon
c1 Bool -> Bool -> Bool
forall a. Eq a => a -> a -> Bool
== DataCon -> Bool
dataConIsInfix DataCon
c2)
           BootDataConMismatch
MismatchedDataConFixities
       ; Bool -> BootDataConMismatch -> BootErrsM BootDataConMismatch
forall err. Bool -> err -> BootErrsM err
check ((HsImplBang -> HsImplBang -> Bool)
-> [HsImplBang] -> [HsImplBang] -> Bool
forall a b. (a -> b -> Bool) -> [a] -> [b] -> Bool
forall (f :: * -> *) a b.
Eq1 f =>
(a -> b -> Bool) -> f a -> f b -> Bool
liftEq HsImplBang -> HsImplBang -> Bool
eqHsBang (DataCon -> [HsImplBang]
dataConImplBangs DataCon
c1) (DataCon -> [HsImplBang]
dataConImplBangs DataCon
c2))
           BootDataConMismatch
MismatchedDataConBangs
       ; Bool -> BootDataConMismatch -> BootErrsM BootDataConMismatch
forall err. Bool -> err -> BootErrsM err
check ((FieldLabel -> Name) -> [FieldLabel] -> [Name]
forall a b. (a -> b) -> [a] -> [b]
map FieldLabel -> Name
flSelector (DataCon -> [FieldLabel]
dataConFieldLabels DataCon
c1) [Name] -> [Name] -> Bool
forall a. Eq a => a -> a -> Bool
== (FieldLabel -> Name) -> [FieldLabel] -> [Name]
forall a b. (a -> b) -> [a] -> [b]
map FieldLabel -> Name
flSelector (DataCon -> [FieldLabel]
dataConFieldLabels DataCon
c2))
           BootDataConMismatch
MismatchedDataConFieldLabels
       ; Bool -> BootDataConMismatch -> BootErrsM BootDataConMismatch
forall err. Bool -> err -> BootErrsM err
check (Type -> Type -> Bool
eqType (DataCon -> Type
dataConWrapperType DataCon
c1) (DataCon -> Type
dataConWrapperType DataCon
c2))
           BootDataConMismatch
MismatchedDataConTypes }

eqClosedFamilyAx :: Maybe (CoAxiom br) -> Maybe (CoAxiom br1)
                 -> BootErrsM BootTyConMismatch
eqClosedFamilyAx :: forall (br :: BranchFlag) (br1 :: BranchFlag).
Maybe (CoAxiom br)
-> Maybe (CoAxiom br1) -> BootErrsM BootTyConMismatch
eqClosedFamilyAx Maybe (CoAxiom br)
Nothing Maybe (CoAxiom br1)
Nothing  = BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess
eqClosedFamilyAx Maybe (CoAxiom br)
Nothing (Just CoAxiom br1
_) = BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. err -> BootErrsM err
bootErr (BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$ BootListMismatches CoAxBranch BootAxiomBranchMismatch
-> BootTyConMismatch
TyConAxiomMismatch (BootListMismatches CoAxBranch BootAxiomBranchMismatch
 -> BootTyConMismatch)
-> BootListMismatches CoAxBranch BootAxiomBranchMismatch
-> BootTyConMismatch
forall a b. (a -> b) -> a -> b
$ BootListMismatch CoAxBranch BootAxiomBranchMismatch
-> BootListMismatches CoAxBranch BootAxiomBranchMismatch
forall a. a -> NonEmpty a
NE.singleton BootListMismatch CoAxBranch BootAxiomBranchMismatch
forall item err. BootListMismatch item err
MismatchedLength
eqClosedFamilyAx (Just CoAxiom br
_) Maybe (CoAxiom br1)
Nothing = BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. err -> BootErrsM err
bootErr (BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$ BootListMismatches CoAxBranch BootAxiomBranchMismatch
-> BootTyConMismatch
TyConAxiomMismatch (BootListMismatches CoAxBranch BootAxiomBranchMismatch
 -> BootTyConMismatch)
-> BootListMismatches CoAxBranch BootAxiomBranchMismatch
-> BootTyConMismatch
forall a b. (a -> b) -> a -> b
$ BootListMismatch CoAxBranch BootAxiomBranchMismatch
-> BootListMismatches CoAxBranch BootAxiomBranchMismatch
forall a. a -> NonEmpty a
NE.singleton BootListMismatch CoAxBranch BootAxiomBranchMismatch
forall item err. BootListMismatch item err
MismatchedLength
eqClosedFamilyAx (Just (CoAxiom { co_ax_branches :: forall (br :: BranchFlag). CoAxiom br -> Branches br
co_ax_branches = Branches br
branches1 }))
                 (Just (CoAxiom { co_ax_branches :: forall (br :: BranchFlag). CoAxiom br -> Branches br
co_ax_branches = Branches br1
branches2 }))
  = (CoAxBranch -> CoAxBranch -> BootErrsM BootAxiomBranchMismatch)
-> [CoAxBranch]
-> [CoAxBranch]
-> (BootListMismatches CoAxBranch BootAxiomBranchMismatch
    -> BootTyConMismatch)
-> BootErrsM BootTyConMismatch
forall a err err2.
(a -> a -> BootErrsM err)
-> [a]
-> [a]
-> (BootListMismatches a err -> err2)
-> BootErrsM err2
checkListBy CoAxBranch -> CoAxBranch -> BootErrsM BootAxiomBranchMismatch
eqClosedFamilyBranch [CoAxBranch]
branch_list1 [CoAxBranch]
branch_list2
      BootListMismatches CoAxBranch BootAxiomBranchMismatch
-> BootTyConMismatch
TyConAxiomMismatch
  where
    branch_list1 :: [CoAxBranch]
branch_list1 = Branches br -> [CoAxBranch]
forall (br :: BranchFlag). Branches br -> [CoAxBranch]
fromBranches Branches br
branches1
    branch_list2 :: [CoAxBranch]
branch_list2 = Branches br1 -> [CoAxBranch]
forall (br :: BranchFlag). Branches br -> [CoAxBranch]
fromBranches Branches br1
branches2

eqClosedFamilyBranch :: CoAxBranch -> CoAxBranch -> BootErrsM BootAxiomBranchMismatch
eqClosedFamilyBranch :: CoAxBranch -> CoAxBranch -> BootErrsM BootAxiomBranchMismatch
eqClosedFamilyBranch (CoAxBranch { cab_tvs :: CoAxBranch -> [Var]
cab_tvs = [Var]
tvs1, cab_cvs :: CoAxBranch -> [Var]
cab_cvs = [Var]
cvs1
                                 , cab_lhs :: CoAxBranch -> [Type]
cab_lhs = [Type]
lhs1, cab_rhs :: CoAxBranch -> Type
cab_rhs = Type
rhs1 })
                     (CoAxBranch { cab_tvs :: CoAxBranch -> [Var]
cab_tvs = [Var]
tvs2, cab_cvs :: CoAxBranch -> [Var]
cab_cvs = [Var]
cvs2
                                 , cab_lhs :: CoAxBranch -> [Type]
cab_lhs = [Type]
lhs2, cab_rhs :: CoAxBranch -> Type
cab_rhs = Type
rhs2 })
  | Just RnEnv2
env1 <- RnEnv2 -> [Var] -> [Var] -> Maybe RnEnv2
eqVarBndrs RnEnv2
emptyRnEnv2 [Var]
tvs1 [Var]
tvs2
  , Just RnEnv2
env  <- RnEnv2 -> [Var] -> [Var] -> Maybe RnEnv2
eqVarBndrs RnEnv2
env1        [Var]
cvs1 [Var]
cvs2
  = do { Bool
-> BootAxiomBranchMismatch -> BootErrsM BootAxiomBranchMismatch
forall err. Bool -> err -> BootErrsM err
check ((Type -> Type -> Bool) -> [Type] -> [Type] -> Bool
forall a b. (a -> b -> Bool) -> [a] -> [b] -> Bool
forall (f :: * -> *) a b.
Eq1 f =>
(a -> b -> Bool) -> f a -> f b -> Bool
liftEq (RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env) [Type]
lhs1 [Type]
lhs2) BootAxiomBranchMismatch
MismatchedAxiomLHS
       ; Bool
-> BootAxiomBranchMismatch -> BootErrsM BootAxiomBranchMismatch
forall err. Bool -> err -> BootErrsM err
check (RnEnv2 -> Type -> Type -> Bool
eqTypeX RnEnv2
env Type
rhs1 Type
rhs2)          BootAxiomBranchMismatch
MismatchedAxiomRHS }
  | Bool
otherwise
  = BootAxiomBranchMismatch -> BootErrsM BootAxiomBranchMismatch
forall err. err -> BootErrsM err
bootErr BootAxiomBranchMismatch
MismatchedAxiomBinders

{- Note [Role subtyping]
~~~~~~~~~~~~~~~~~~~~~~~~
In the current formulation of roles, role subtyping is only OK if the
"abstract" TyCon was not representationally injective.  Among the most
notable examples of non representationally injective TyCons are abstract
data, which can be implemented via newtypes (which are not
representationally injective).  The key example is
in this example from #13140:

     -- In an hsig file
     data T a -- abstract!
     type role T nominal

     -- Elsewhere
     foo :: Coercible (T a) (T b) => a -> b
     foo x = x

We must NOT allow foo to typecheck, because if we instantiate
T with a concrete data type with a phantom role would cause
Coercible (T a) (T b) to be provable.  Fortunately, if T is not
representationally injective, we cannot make the inference that a ~N b if
T a ~R T b.

Unconditional role subtyping would be possible if we setup
an extra set of roles saying when we can project out coercions
(we call these proj-roles); then it would NOT be valid to instantiate T
with a data type at phantom since the proj-role subtyping check
would fail.  See #13140 for more details.

One consequence of this is we get no role subtyping for non-abstract
data types in signatures. Suppose you have:

     signature A where
         type role T nominal
         data T a = MkT

If you write this, we'll treat T as injective, and make inferences
like T a ~R T b ==> a ~N b (mkSelCo).  But if we can
subsequently replace T with one at phantom role, we would then be able to
infer things like T Int ~R T Bool which is bad news.

We could allow role subtyping here if we didn't treat *any* data types
defined in signatures as injective.  But this would be a bit surprising,
replacing a data type in a module with one in a signature could cause
your code to stop typechecking (whereas if you made the type abstract,
it is more understandable that the type checker knows less).

It would have been best if this was purely a question of defaults
(i.e., a user could explicitly ask for one behavior or another) but
the current role system isn't expressive enough to do this.
Having explicit proj-roles would solve this problem.
-}

checkRoles :: HsBootOrSig -> TyCon -> [Role] -> BootErrsM BootTyConMismatch
checkRoles :: HsBootOrSig -> TyCon -> [Role] -> BootErrsM BootTyConMismatch
checkRoles HsBootOrSig
boot_or_sig TyCon
tc1 [Role]
r2
  |  HsBootOrSig
boot_or_sig HsBootOrSig -> HsBootOrSig -> Bool
forall a. Eq a => a -> a -> Bool
== HsBootOrSig
HsBoot
  Bool -> Bool -> Bool
|| TyCon -> Role -> Bool
isInjectiveTyCon TyCon
tc1 Role
Representational -- See Note [Role subtyping]
  = Bool -> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. Bool -> err -> BootErrsM err
check ([Role]
r1 [Role] -> [Role] -> Bool
forall a. Eq a => a -> a -> Bool
== [Role]
r2) (Bool -> BootTyConMismatch
TyConRoleMismatch Bool
False)
  | Bool
otherwise
  = Bool -> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. Bool -> err -> BootErrsM err
check ([Role]
r2 [Role] -> [Role] -> Bool
forall {a}. Ord a => [a] -> [a] -> Bool
`rolesSubtypeOf` [Role]
r1) (Bool -> BootTyConMismatch
TyConRoleMismatch Bool
True)
  where

    r1 :: [Role]
r1 = TyCon -> [Role]
tyConRoles TyCon
tc1

    rolesSubtypeOf :: [a] -> [a] -> Bool
rolesSubtypeOf [] [] = Bool
True
    -- NB: this relation is the OPPOSITE of the subroling relation
    rolesSubtypeOf (a
x:[a]
xs) (a
y:[a]
ys) = a
x a -> a -> Bool
forall a. Ord a => a -> a -> Bool
>= a
y Bool -> Bool -> Bool
&& [a] -> [a] -> Bool
rolesSubtypeOf [a]
xs [a]
ys
    rolesSubtypeOf [a]
_ [a]
_ = Bool
False

{- Note [Synonyms implement abstract data]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
An abstract data type or class can be implemented using a type synonym,
but ONLY if:

  1. T, as a standalone occurrence, is a valid type
     (T is "curryable"), and

  2. T is valid in an instance head.

This gives rise to the following conditions under which we can implement
an abstract data declaration @data T@ using a type synonym @type T tvs = rhs@:

  1. The type synonym T is nullary (tvs is null).

  2. The rhs must not contain any foralls, quantified types, or type family
     applications.
     See 'invalidAbsDataSubTypes' which computes a collection of
     invalid subtypes.

See also 'HowAbstract' and Note [Skolem abstract data].
-}

-- | We are implementing an abstract data declaration of the form @data T@
-- in a signature file, with a type synonym @type T tvs = rhs@ in the
-- implementing module.
--
-- This function checks that the implementation is valid:
--
--  1. the type synonym T is nullary, i.e. tvs is null,
--  2. rhs doesn't contain any type families, foralls, or qualified types.
--
-- See Note [Synonyms implement abstract data]
checkSynAbsData :: TyCon   -- ^ @tc1@, the abstract data 'TyCon' we are implementing
                -> TyCon   -- ^ @tc2@, a type synonym @type T tvs = ty@
                           --   we are using to implement @tc1@
                -> [TyVar] -- ^ @tvs@
                -> Type    -- ^ @ty@
                -> BootErrsM BootTyConMismatch
checkSynAbsData :: TyCon -> TyCon -> [Var] -> Type -> BootErrsM BootTyConMismatch
checkSynAbsData TyCon
tc1 TyCon
tc2 [Var]
syn_tvs Type
syn_rhs
  -- We are implementing @data T@ with @type T tvs = rhs@.
  -- Check the conditions of Note [Synonyms implement abstract data].
  = do { -- (1): T is nullary.
       ; Bool -> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. Bool -> err -> BootErrsM err
check ([Var] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [Var]
syn_tvs) (BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
           SynAbstractDataError -> BootTyConMismatch
SynAbstractData SynAbstractDataError
SynAbsDataTySynNotNullary
         -- (2): the RHS of the type synonym is valid.
       ; case Type -> [Type]
invalidAbsDataSubTypes Type
syn_rhs of
          []       -> BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess
          Type
err:[Type]
errs -> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall err. err -> BootErrsM err
bootErr (BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$ SynAbstractDataError -> BootTyConMismatch
SynAbstractData (SynAbstractDataError -> BootTyConMismatch)
-> SynAbstractDataError -> BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
                      NonEmpty Type -> SynAbstractDataError
SynAbstractDataInvalidRHS (Type
err Type -> [Type] -> NonEmpty Type
forall a. a -> [a] -> NonEmpty a
:| [Type]
errs)
         -- NB: this allows implementing e.g. @data T :: Nat@ with @type T = 3@.
         -- See #15138.

  -- TODO: When it's a synonym implementing a class, we really
  -- should check that the fundeps are satisfied, but
  -- there is not an obvious way to do this for a constraint synonym.
  -- So for now, let it all through (it won't cause segfaults, anyway).
  -- Tracked at #12704.

         -- ... we also need to check roles.
       ; if | Just (TyCon
tc2', [Type]
args) <- HasDebugCallStack => Type -> Maybe (TyCon, [Type])
Type -> Maybe (TyCon, [Type])
tcSplitTyConApp_maybe Type
syn_rhs
            , [Var] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [Var]
syn_tvs -- Don't report role errors unless the type synonym is nullary
            -> Bool -> BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a. HasCallStack => Bool -> a -> a
assert ([Role] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null (TyCon -> [Role]
tyConRoles TyCon
tc2)) (BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch)
-> BootErrsM BootTyConMismatch -> BootErrsM BootTyConMismatch
forall a b. (a -> b) -> a -> b
$
               -- If we have something like:
               --
               --  signature H where
               --      data T a
               --  module H where
               --      data K a b = ...
               --      type T = K Int
               --
               -- we need to drop the first role of K when comparing!
               HsBootOrSig -> TyCon -> [Role] -> BootErrsM BootTyConMismatch
checkRoles HsBootOrSig
Hsig TyCon
tc1 (Arity -> [Role] -> [Role]
forall a. Arity -> [a] -> [a]
drop ([Type] -> Arity
forall a. [a] -> Arity
forall (t :: * -> *) a. Foldable t => t a -> Arity
length [Type]
args) (TyCon -> [Role]
tyConRoles TyCon
tc2'))
            | Bool
otherwise
            -> BootErrsM BootTyConMismatch
forall err. BootErrsM err
checkSuccess
       }

{-
    -- Hypothetically, if we were allow to non-nullary type synonyms, here
    -- is how you would check the roles
    if length tvs == length roles1
    then checkRoles roles1 roles2
    else case tcSplitTyConApp_maybe ty of
            Just (tc2', args) ->
                checkRoles Hsig tc1 (drop (length args) (tyConRoles tc2') ++ roles2)
            Nothing -> Just roles_msg
-}

-- | Is this type a valid implementation of abstract data?
--
-- Returns a list of invalid sub-types encountered.
invalidAbsDataSubTypes :: Type -> [Type]
invalidAbsDataSubTypes :: Type -> [Type]
invalidAbsDataSubTypes = Writer [Type] () -> [Type]
forall w a. Monoid w => Writer w a -> w
execWriter (Writer [Type] () -> [Type])
-> (Type -> Writer [Type] ()) -> Type -> [Type]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Type -> Writer [Type] ()
go
  where
    go :: Type -> Writer [Type] ()
    go :: Type -> Writer [Type] ()
go Type
ty
      | Just Type
ty' <- Type -> Maybe Type
coreView Type
ty
      = Type -> Writer [Type] ()
go Type
ty'
    go TyVarTy{}
      = Writer [Type] ()
ok -- We report an error at the binding site of type variables,
           -- e.g. in the TySyn LHS or in the forall.
           -- It's not useful to report a second error for their occurrences
    go (AppTy Type
t1 Type
t2)
      = do { Type -> Writer [Type] ()
go Type
t1; Type -> Writer [Type] ()
go Type
t2 }
    go ty :: Type
ty@(TyConApp TyCon
tc [Type]
tys)
      | TyCon -> Bool
isTypeFamilyTyCon TyCon
tc
      = Type -> Writer [Type] ()
forall {m :: * -> *} {a}. Monad m => a -> WriterT [a] m ()
invalid Type
ty
      | Bool
otherwise
      = (Type -> Writer [Type] ()) -> [Type] -> Writer [Type] ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ Type -> Writer [Type] ()
go [Type]
tys
    go ty :: Type
ty@(ForAllTy{})
      = Type -> Writer [Type] ()
forall {m :: * -> *} {a}. Monad m => a -> WriterT [a] m ()
invalid Type
ty
    go ty :: Type
ty@(FunTy FunTyFlag
af Type
w Type
t1 Type
t2)
      | FunTyFlag
af FunTyFlag -> FunTyFlag -> Bool
forall a. Eq a => a -> a -> Bool
== FunTyFlag
FTF_T_T
      = do { Type -> Writer [Type] ()
go Type
w
           ; Type -> Writer [Type] ()
go (HasDebugCallStack => Type -> Type
Type -> Type
typeKind Type
t1) ; Type -> Writer [Type] ()
go Type
t1
           ; Type -> Writer [Type] ()
go (HasDebugCallStack => Type -> Type
Type -> Type
typeKind Type
t2) ; Type -> Writer [Type] ()
go Type
t2
           }
      | Bool
otherwise
      = Type -> Writer [Type] ()
forall {m :: * -> *} {a}. Monad m => a -> WriterT [a] m ()
invalid Type
ty
    go LitTy{}
      = Writer [Type] ()
ok
    go ty :: Type
ty@(CastTy{})
      = Type -> Writer [Type] ()
forall {m :: * -> *} {a}. Monad m => a -> WriterT [a] m ()
invalid Type
ty
    go ty :: Type
ty@(CoercionTy{})
      = Type -> Writer [Type] ()
forall {m :: * -> *} {a}. Monad m => a -> WriterT [a] m ()
invalid Type
ty

    ok :: Writer [Type] ()
ok         = () -> Writer [Type] ()
forall a. a -> WriterT [Type] Identity a
forall (f :: * -> *) a. Applicative f => a -> f a
pure ()
    invalid :: a -> WriterT [a] m ()
invalid a
ty = [a] -> WriterT [a] m ()
forall w (m :: * -> *). (Monoid w, Monad m) => w -> WriterT w m ()
tell [a
ty]

{-
************************************************************************
*                                                                      *
        Type-checking the top level of a module (continued)
*                                                                      *
************************************************************************
-}

rnTopSrcDecls :: HsGroup GhcPs -> TcM (TcGblEnv, HsGroup GhcRn)
-- Fails if there are any errors
rnTopSrcDecls :: HsGroup GhcPs -> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
rnTopSrcDecls HsGroup GhcPs
group
 = do { -- Rename the source decls
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn12" SDoc
forall doc. IsOutput doc => doc
empty ;
        (TcGblEnv
tcg_env, HsGroup (GhcPass 'Renamed)
rn_decls) <- TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall r. TcM r -> TcM r
checkNoErrs (TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
 -> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed)))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$ HsGroup GhcPs -> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
rnSrcDecls HsGroup GhcPs
group ;
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn13" SDoc
forall doc. IsOutput doc => doc
empty ;
        (TcGblEnv
tcg_env, HsGroup (GhcPass 'Renamed)
rn_decls) <- TcGblEnv
-> HsGroup (GhcPass 'Renamed)
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
runRenamerPlugin TcGblEnv
tcg_env HsGroup (GhcPass 'Renamed)
rn_decls ;
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"rn13-plugin" SDoc
forall doc. IsOutput doc => doc
empty ;

        -- save the renamed syntax, if we want it
        let { tcg_env' :: TcGblEnv
tcg_env'
                | Just HsGroup (GhcPass 'Renamed)
grp <- TcGblEnv -> Maybe (HsGroup (GhcPass 'Renamed))
tcg_rn_decls TcGblEnv
tcg_env
                  = TcGblEnv
tcg_env{ tcg_rn_decls = Just (appendGroups grp rn_decls) }
                | Bool
otherwise
                   = TcGblEnv
tcg_env };

                -- Dump trace of renaming part
        HsGroup (GhcPass 'Renamed) -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a.
(Outputable a, Data a) =>
a -> IOEnv (Env TcGblEnv TcLclEnv) ()
rnDump HsGroup (GhcPass 'Renamed)
rn_decls ;
        (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env', HsGroup (GhcPass 'Renamed)
rn_decls)
   }

tcTopSrcDecls :: HsGroup GhcRn -> TcM (TcGblEnv, TcLclEnv)
tcTopSrcDecls :: HsGroup (GhcPass 'Renamed)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
tcTopSrcDecls (HsGroup { hs_tyclds :: forall p. HsGroup p -> [TyClGroup p]
hs_tyclds = [TyClGroup (GhcPass 'Renamed)]
tycl_decls,
                         hs_derivds :: forall p. HsGroup p -> [LDerivDecl p]
hs_derivds = [LDerivDecl (GhcPass 'Renamed)]
deriv_decls,
                         hs_fords :: forall p. HsGroup p -> [LForeignDecl p]
hs_fords  = [LForeignDecl (GhcPass 'Renamed)]
foreign_decls,
                         hs_defds :: forall p. HsGroup p -> [LDefaultDecl p]
hs_defds  = [LDefaultDecl (GhcPass 'Renamed)]
default_decls,
                         hs_annds :: forall p. HsGroup p -> [LAnnDecl p]
hs_annds  = [LAnnDecl (GhcPass 'Renamed)]
annotation_decls,
                         hs_ruleds :: forall p. HsGroup p -> [LRuleDecls p]
hs_ruleds = [LRuleDecls (GhcPass 'Renamed)]
rule_decls,
                         hs_valds :: forall p. HsGroup p -> HsValBinds p
hs_valds  = hs_val_binds :: HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
hs_val_binds@(XValBindsLR
                                              (NValBinds [(RecFlag, LHsBinds (GhcPass 'Renamed))]
val_binds [LSig (GhcPass 'Renamed)]
val_sigs)) })
 = do {         -- Type-check the type and class decls, and all imported decls
                -- The latter come in via tycl_decls
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc2 (src)" SDoc
forall doc. IsOutput doc => doc
empty ;

                -- Source-language instances, including derivings,
                -- and import the supporting declarations
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc3" SDoc
forall doc. IsOutput doc => doc
empty ;
        (TcGblEnv
tcg_env, [InstInfo (GhcPass 'Renamed)]
inst_infos, ThBindEnv
th_bndrs,
         XValBindsLR (NValBinds [(RecFlag, LHsBinds (GhcPass 'Renamed))]
deriv_binds [LSig (GhcPass 'Renamed)]
deriv_sigs))
            <- [TyClGroup (GhcPass 'Renamed)]
-> [LDerivDecl (GhcPass 'Renamed)]
-> [(RecFlag, LHsBinds (GhcPass 'Renamed))]
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
tcTyClsInstDecls [TyClGroup (GhcPass 'Renamed)]
tycl_decls [LDerivDecl (GhcPass 'Renamed)]
deriv_decls [(RecFlag, LHsBinds (GhcPass 'Renamed))]
val_binds ;

        (TcLclCtxt -> TcLclCtxt)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall gbl a.
(TcLclCtxt -> TcLclCtxt)
-> TcRnIf gbl TcLclEnv a -> TcRnIf gbl TcLclEnv a
updLclCtxt (\TcLclCtxt
tcl_env -> TcLclCtxt
tcl_env { tcl_th_bndrs = th_bndrs `plusNameEnv` tcl_th_bndrs tcl_env }) (TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
 -> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv))
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a b. (a -> b) -> a -> b
$
        TcGblEnv
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env       (TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
 -> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv))
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a b. (a -> b) -> a -> b
$ do {

                -- Foreign import declarations next.
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc4" SDoc
forall doc. IsOutput doc => doc
empty ;
        ([Var]
fi_ids, [GenLocated SrcSpanAnnA (ForeignDecl GhcTc)]
fi_decls, Bag GlobalRdrElt
fi_gres) <- [LForeignDecl (GhcPass 'Renamed)]
-> TcM ([Var], [LForeignDecl GhcTc], Bag GlobalRdrElt)
tcForeignImports [LForeignDecl (GhcPass 'Renamed)]
foreign_decls ;
        [Var]
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a. [Var] -> TcM a -> TcM a
tcExtendGlobalValEnv [Var]
fi_ids     (TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
 -> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv))
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a b. (a -> b) -> a -> b
$ do {

                -- Default declarations
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc4a" SDoc
forall doc. IsOutput doc => doc
empty ;
        Maybe [Type]
default_tys <- [LDefaultDecl (GhcPass 'Renamed)] -> TcM (Maybe [Type])
tcDefaults [LDefaultDecl (GhcPass 'Renamed)]
default_decls ;
        (TcGblEnv -> TcGblEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall gbl lcl a.
(gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
updGblEnv (\TcGblEnv
gbl -> TcGblEnv
gbl { tcg_default = default_tys }) (TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
 -> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv))
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a b. (a -> b) -> a -> b
$ do {

                -- Value declarations next.
                -- It is important that we check the top-level value bindings
                -- before the GHC-generated derived bindings, since the latter
                -- may be defined in terms of the former. (For instance,
                -- the bindings produced in a Data instance.)
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc5" SDoc
forall doc. IsOutput doc => doc
empty ;
        (TcGblEnv, TcLclEnv)
tc_envs <- [(RecFlag, LHsBinds (GhcPass 'Renamed))]
-> [LSig (GhcPass 'Renamed)]
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
tcTopBinds [(RecFlag, LHsBinds (GhcPass 'Renamed))]
val_binds [LSig (GhcPass 'Renamed)]
val_sigs;
        (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a. (TcGblEnv, TcLclEnv) -> TcRn a -> TcRn a
restoreEnvs (TcGblEnv, TcLclEnv)
tc_envs (TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
 -> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv))
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a b. (a -> b) -> a -> b
$ do {

                -- Now GHC-generated derived bindings, generics, and selectors
                -- Do not generate warnings from compiler-generated code;
                -- hence the use of discardWarnings
        tc_envs :: (TcGblEnv, TcLclEnv)
tc_envs@(TcGblEnv
tcg_env, TcLclEnv
tcl_env)
            <- TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall r. TcM r -> TcM r
discardWarnings ([(RecFlag, LHsBinds (GhcPass 'Renamed))]
-> [LSig (GhcPass 'Renamed)]
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
tcTopBinds [(RecFlag, LHsBinds (GhcPass 'Renamed))]
deriv_binds [LSig (GhcPass 'Renamed)]
deriv_sigs) ;
        (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a. (TcGblEnv, TcLclEnv) -> TcRn a -> TcRn a
restoreEnvs (TcGblEnv, TcLclEnv)
tc_envs (TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
 -> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv))
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a b. (a -> b) -> a -> b
$ do {  -- Environment doesn't change now

                -- Second pass over class and instance declarations,
                -- now using the kind-checked decls
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc6" SDoc
forall doc. IsOutput doc => doc
empty ;
        Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
inst_binds <- [LTyClDecl (GhcPass 'Renamed)]
-> [InstInfo (GhcPass 'Renamed)] -> TcM (LHsBinds GhcTc)
tcInstDecls2 ([TyClGroup (GhcPass 'Renamed)] -> [LTyClDecl (GhcPass 'Renamed)]
forall pass. [TyClGroup pass] -> [LTyClDecl pass]
tyClGroupTyClDecls [TyClGroup (GhcPass 'Renamed)]
tycl_decls) [InstInfo (GhcPass 'Renamed)]
inst_infos ;

                -- Foreign exports
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc7" SDoc
forall doc. IsOutput doc => doc
empty ;
        (Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
foe_binds, [GenLocated SrcSpanAnnA (ForeignDecl GhcTc)]
foe_decls, Bag GlobalRdrElt
foe_gres) <- [LForeignDecl (GhcPass 'Renamed)]
-> TcM (LHsBinds GhcTc, [LForeignDecl GhcTc], Bag GlobalRdrElt)
tcForeignExports [LForeignDecl (GhcPass 'Renamed)]
foreign_decls ;

                -- Annotations
        [Annotation]
annotations <- [LAnnDecl (GhcPass 'Renamed)] -> TcM [Annotation]
tcAnnotations [LAnnDecl (GhcPass 'Renamed)]
annotation_decls ;

                -- Rules
        [GenLocated SrcSpanAnnA (RuleDecls GhcTc)]
rules <- [LRuleDecls (GhcPass 'Renamed)] -> TcM [LRuleDecls GhcTc]
tcRules [LRuleDecls (GhcPass 'Renamed)]
rule_decls ;

                -- Wrap up
        String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"Tc7a" SDoc
forall doc. IsOutput doc => doc
empty ;
        let { all_binds :: Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
all_binds = Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
inst_binds     Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
-> Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
-> Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
forall a. Bag a -> Bag a -> Bag a
`unionBags`
                          Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
foe_binds

            ; fo_gres :: Bag GlobalRdrElt
fo_gres = Bag GlobalRdrElt
fi_gres Bag GlobalRdrElt -> Bag GlobalRdrElt -> Bag GlobalRdrElt
forall a. Bag a -> Bag a -> Bag a
`unionBags` Bag GlobalRdrElt
foe_gres
            ; fo_fvs :: FreeVars
fo_fvs = (GlobalRdrElt -> FreeVars -> FreeVars)
-> FreeVars -> Bag GlobalRdrElt -> FreeVars
forall a b. (a -> b -> b) -> b -> Bag a -> b
forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr (\GlobalRdrElt
gre FreeVars
fvs -> FreeVars
fvs FreeVars -> Name -> FreeVars
`addOneFV` (GlobalRdrElt -> Name
forall info. GlobalRdrEltX info -> Name
greName GlobalRdrElt
gre))
                                FreeVars
emptyFVs Bag GlobalRdrElt
fo_gres

            ; sig_names :: FreeVars
sig_names = [Name] -> FreeVars
mkNameSet (CollectFlag (GhcPass 'Renamed)
-> HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
-> [IdP (GhcPass 'Renamed)]
forall (idL :: Pass) idR.
CollectPass (GhcPass idL) =>
CollectFlag (GhcPass idL)
-> HsValBindsLR (GhcPass idL) idR -> [IdP (GhcPass idL)]
collectHsValBinders CollectFlag (GhcPass 'Renamed)
forall p. CollectFlag p
CollNoDictBinders HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
hs_val_binds)
                          FreeVars -> FreeVars -> FreeVars
`minusNameSet` [LSig (GhcPass 'Renamed)] -> FreeVars
getTypeSigNames [LSig (GhcPass 'Renamed)]
val_sigs

                -- Extend the GblEnv with the (as yet un-zonked)
                -- bindings, rules, foreign decls
            ; tcg_env' :: TcGblEnv
tcg_env' = TcGblEnv
tcg_env { tcg_binds   = tcg_binds tcg_env `unionBags` all_binds
                                 , tcg_sigs    = tcg_sigs tcg_env `unionNameSet` sig_names
                                 , tcg_rules   = tcg_rules tcg_env
                                                      ++ flattenRuleDecls rules
                                 , tcg_anns    = tcg_anns tcg_env ++ annotations
                                 , tcg_ann_env = extendAnnEnvList (tcg_ann_env tcg_env) annotations
                                 , tcg_fords   = tcg_fords tcg_env ++ foe_decls ++ fi_decls
                                 , tcg_dus     = tcg_dus tcg_env `plusDU` usesOnly fo_fvs } } ;
                                 -- tcg_dus: see Note [Newtype constructor usage in foreign declarations]

        -- See Note [Newtype constructor usage in foreign declarations]
        DeprecationWarnings
-> [GlobalRdrElt] -> IOEnv (Env TcGblEnv TcLclEnv) ()
addUsedGREs DeprecationWarnings
NoDeprecationWarnings (Bag GlobalRdrElt -> [GlobalRdrElt]
forall a. Bag a -> [a]
bagToList Bag GlobalRdrElt
fo_gres) ;

        (TcGblEnv, TcLclEnv)
-> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env', TcLclEnv
tcl_env)
    }}}}}}

tcTopSrcDecls HsGroup (GhcPass 'Renamed)
_ = String -> TcRnIf TcGblEnv TcLclEnv (TcGblEnv, TcLclEnv)
forall a. HasCallStack => String -> a
panic String
"tcTopSrcDecls: ValBindsIn"

---------------------------
tcTyClsInstDecls :: [TyClGroup GhcRn]
                 -> [LDerivDecl GhcRn]
                 -> [(RecFlag, LHsBinds GhcRn)]
                 -> TcM (TcGblEnv,            -- The full inst env
                         [InstInfo GhcRn],    -- Source-code instance decls to
                                              -- process; contains all dfuns for
                                              -- this module
                          ThBindEnv,          -- TH binding levels
                          HsValBinds GhcRn)   -- Supporting bindings for derived
                                              -- instances

tcTyClsInstDecls :: [TyClGroup (GhcPass 'Renamed)]
-> [LDerivDecl (GhcPass 'Renamed)]
-> [(RecFlag, LHsBinds (GhcPass 'Renamed))]
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
tcTyClsInstDecls [TyClGroup (GhcPass 'Renamed)]
tycl_decls [LDerivDecl (GhcPass 'Renamed)]
deriv_decls [(RecFlag, LHsBinds (GhcPass 'Renamed))]
binds
 = [LInstDecl (GhcPass 'Renamed)]
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall a. [LInstDecl (GhcPass 'Renamed)] -> TcM a -> TcM a
tcAddDataFamConPlaceholders ([TyClGroup (GhcPass 'Renamed)]
tycl_decls [TyClGroup (GhcPass 'Renamed)]
-> (TyClGroup (GhcPass 'Renamed)
    -> [GenLocated SrcSpanAnnA (InstDecl (GhcPass 'Renamed))])
-> [GenLocated SrcSpanAnnA (InstDecl (GhcPass 'Renamed))]
forall a b. [a] -> (a -> [b]) -> [b]
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= TyClGroup (GhcPass 'Renamed) -> [LInstDecl (GhcPass 'Renamed)]
TyClGroup (GhcPass 'Renamed)
-> [GenLocated SrcSpanAnnA (InstDecl (GhcPass 'Renamed))]
forall pass. TyClGroup pass -> [LInstDecl pass]
group_instds) (TcM
   (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
    HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
 -> TcM
      (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
       HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$
   [PatSynBind (GhcPass 'Renamed) (GhcPass 'Renamed)]
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall a.
[PatSynBind (GhcPass 'Renamed) (GhcPass 'Renamed)]
-> TcM a -> TcM a
tcAddPatSynPlaceholders ([(RecFlag, LHsBinds (GhcPass 'Renamed))]
-> [PatSynBind (GhcPass 'Renamed) (GhcPass 'Renamed)]
forall id.
UnXRec id =>
[(RecFlag, LHsBinds id)] -> [PatSynBind id id]
getPatSynBinds [(RecFlag, LHsBinds (GhcPass 'Renamed))]
binds) (TcM
   (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
    HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
 -> TcM
      (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
       HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$
   do { (TcGblEnv
tcg_env, [InstInfo (GhcPass 'Renamed)]
inst_info, [DerivInfo]
deriv_info, ThBindEnv
th_bndrs)
          <- [TyClGroup (GhcPass 'Renamed)]
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], [DerivInfo], ThBindEnv)
tcTyAndClassDecls [TyClGroup (GhcPass 'Renamed)]
tycl_decls ;
      ; TcGblEnv
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env (TcM
   (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
    HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
 -> TcM
      (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
       HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$ do {
          -- With the @TyClDecl@s and @InstDecl@s checked we're ready to
          -- process the deriving clauses, including data family deriving
          -- clauses discovered in @tcTyAndClassDecls@.
          --
          -- Careful to quit now in case there were instance errors, so that
          -- the deriving errors don't pile up as well.
          ; IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM
          ; (TcGblEnv
tcg_env', [InstInfo (GhcPass 'Renamed)]
inst_info', HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
val_binds)
              <- [DerivInfo]
-> [LDerivDecl (GhcPass 'Renamed)]
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)],
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
tcInstDeclsDeriv [DerivInfo]
deriv_info [LDerivDecl (GhcPass 'Renamed)]
deriv_decls
          ; TcGblEnv
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall gbl' lcl a gbl.
gbl' -> TcRnIf gbl' lcl a -> TcRnIf gbl lcl a
setGblEnv TcGblEnv
tcg_env' (TcM
   (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
    HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
 -> TcM
      (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
       HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$ do {
                IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM
              ; (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
 HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> TcM
     (TcGblEnv, [InstInfo (GhcPass 'Renamed)], ThBindEnv,
      HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (f :: * -> *) a. Applicative f => a -> f a
pure ( TcGblEnv
tcg_env', [InstInfo (GhcPass 'Renamed)]
inst_info' [InstInfo (GhcPass 'Renamed)]
-> [InstInfo (GhcPass 'Renamed)] -> [InstInfo (GhcPass 'Renamed)]
forall a. [a] -> [a] -> [a]
++ [InstInfo (GhcPass 'Renamed)]
inst_info, ThBindEnv
th_bndrs, HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
val_binds )
      }}}

{- *********************************************************************
*                                                                      *
        Checking for 'main'
*                                                                      *
************************************************************************
-}

checkMainType :: TcGblEnv -> TcRn WantedConstraints
-- If this is the Main module, and it defines a function main,
--   check that its type is of form IO tau.
-- If not, do nothing
-- See Note [Dealing with main]
checkMainType :: TcGblEnv -> TcRn WantedConstraints
checkMainType TcGblEnv
tcg_env
  = do { HscEnv
hsc_env <- TcRnIf TcGblEnv TcLclEnv HscEnv
forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
       ; if TcGblEnv -> Module
tcg_mod TcGblEnv
tcg_env Module -> Module -> Bool
forall a. Eq a => a -> a -> Bool
/= HomeUnitEnv -> Module
mainModIs (HscEnv -> HomeUnitEnv
hsc_HUE HscEnv
hsc_env)
         then WantedConstraints -> TcRn WantedConstraints
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return WantedConstraints
emptyWC else

    do { GlobalRdrEnv
rdr_env <- TcRn GlobalRdrEnv
getGlobalRdrEnv
       ; let dflags :: DynFlags
dflags    = HscEnv -> DynFlags
hsc_dflags HscEnv
hsc_env
             main_occ :: OccName
main_occ  = DynFlags -> OccName
getMainOcc DynFlags
dflags
             main_gres :: [GlobalRdrElt]
main_gres = GlobalRdrEnv -> LookupGRE GREInfo -> [GlobalRdrElt]
forall info.
GlobalRdrEnvX info -> LookupGRE info -> [GlobalRdrEltX info]
lookupGRE GlobalRdrEnv
rdr_env (OccName -> WhichGREs GREInfo -> LookupGRE GREInfo
forall info. OccName -> WhichGREs info -> LookupGRE info
LookupOccName OccName
main_occ WhichGREs GREInfo
forall info. WhichGREs info
SameNameSpace)
       ; case (GlobalRdrElt -> Bool) -> [GlobalRdrElt] -> [GlobalRdrElt]
forall a. (a -> Bool) -> [a] -> [a]
filter GlobalRdrElt -> Bool
forall info. GlobalRdrEltX info -> Bool
isLocalGRE [GlobalRdrElt]
main_gres of {
            []         -> WantedConstraints -> TcRn WantedConstraints
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return WantedConstraints
emptyWC ;
            (GlobalRdrElt
_:GlobalRdrElt
_:[GlobalRdrElt]
_)    -> WantedConstraints -> TcRn WantedConstraints
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return WantedConstraints
emptyWC ;
            [GlobalRdrElt
main_gre] ->

    do { let main_name :: Name
main_name = GlobalRdrElt -> Name
forall info. GlobalRdrEltX info -> Name
greName GlobalRdrElt
main_gre
             ctxt :: UserTypeCtxt
ctxt      = Name -> ReportRedundantConstraints -> UserTypeCtxt
FunSigCtxt Name
main_name ReportRedundantConstraints
NoRRC
       ; Var
main_id   <- Name -> TcM Var
tcLookupId Name
main_name
       ; (Type
io_ty,Type
_) <- TcM (Type, Type)
getIOType
       ; let main_ty :: Type
main_ty   = Var -> Type
idType Var
main_id
             eq_orig :: CtOrigin
eq_orig   = TypeEqOrigin { uo_actual :: Type
uo_actual   = Type
main_ty
                                      , uo_expected :: Type
uo_expected = Type
io_ty
                                      , uo_thing :: Maybe TypedThing
uo_thing    = Maybe TypedThing
forall a. Maybe a
Nothing
                                      , uo_visible :: Bool
uo_visible  = Bool
True }
       ; ((TcEvBinds, HsWrapper)
_, WantedConstraints
lie)  <- TcM (TcEvBinds, HsWrapper)
-> TcM ((TcEvBinds, HsWrapper), WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureTopConstraints       (TcM (TcEvBinds, HsWrapper)
 -> TcM ((TcEvBinds, HsWrapper), WantedConstraints))
-> TcM (TcEvBinds, HsWrapper)
-> TcM ((TcEvBinds, HsWrapper), WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                      Name -> Type -> TcM HsWrapper -> TcM (TcEvBinds, HsWrapper)
forall a. Name -> Type -> TcM a -> TcM (TcEvBinds, a)
setMainCtxt Name
main_name Type
io_ty (TcM HsWrapper -> TcM (TcEvBinds, HsWrapper))
-> TcM HsWrapper -> TcM (TcEvBinds, HsWrapper)
forall a b. (a -> b) -> a -> b
$
                      CtOrigin -> UserTypeCtxt -> Type -> Type -> TcM HsWrapper
tcSubTypeSigma CtOrigin
eq_orig UserTypeCtxt
ctxt Type
main_ty Type
io_ty
       ; WantedConstraints -> TcRn WantedConstraints
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return WantedConstraints
lie } } } }

checkMain :: Bool  -- False => no 'module M(..) where' header at all
          -> Maybe (LocatedL [LIE GhcPs])  -- Export specs of Main module
          -> TcM TcGblEnv
-- If we are in module Main, check that 'main' is exported,
-- and generate the runMainIO binding that calls it
-- See Note [Dealing with main]
checkMain :: Bool
-> Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
-> TcM TcGblEnv
checkMain Bool
explicit_mod_hdr Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
export_ies
 = do { HscEnv
hsc_env  <- TcRnIf TcGblEnv TcLclEnv HscEnv
forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
      ; TcGblEnv
tcg_env <- TcM TcGblEnv
forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv

      ; let dflags :: DynFlags
dflags      = HscEnv -> DynFlags
hsc_dflags HscEnv
hsc_env
            main_mod :: Module
main_mod    = HomeUnitEnv -> Module
mainModIs (HscEnv -> HomeUnitEnv
hsc_HUE HscEnv
hsc_env)
            main_occ :: OccName
main_occ    = DynFlags -> OccName
getMainOcc DynFlags
dflags

            exported_mains :: [Name]
            -- Exported things that are called 'main'
            exported_mains :: [Name]
exported_mains  = [ Name
name | AvailInfo
avail <- TcGblEnv -> [AvailInfo]
tcg_exports TcGblEnv
tcg_env
                                     , Name
name  <- AvailInfo -> [Name]
availNames AvailInfo
avail
                                     , Name -> OccName
nameOccName Name
name OccName -> OccName -> Bool
forall a. Eq a => a -> a -> Bool
== OccName
main_occ ]

      ; if | TcGblEnv -> Module
tcg_mod TcGblEnv
tcg_env Module -> Module -> Bool
forall a. Eq a => a -> a -> Bool
/= Module
main_mod
           -> -- Not the main module
              TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return TcGblEnv
tcg_env

           | [Name
main_name] <- [Name]
exported_mains
           -> -- The module indeed exports a function called 'main'
              TcGblEnv -> Name -> TcM TcGblEnv
generateMainBinding TcGblEnv
tcg_env Name
main_name

           | Bool
otherwise
           -> Bool -> TcM TcGblEnv -> TcM TcGblEnv
forall a. HasCallStack => Bool -> a -> a
assert ([Name] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [Name]
exported_mains) (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$
              -- A fully-checked export list can't contain more
              -- than one function with the same OccName
              do { DynFlags -> Module -> OccName -> IOEnv (Env TcGblEnv TcLclEnv) ()
complain_no_main DynFlags
dflags Module
main_mod OccName
main_occ
                 ; TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return TcGblEnv
tcg_env } }
  where
    complain_no_main :: DynFlags -> Module -> OccName -> IOEnv (Env TcGblEnv TcLclEnv) ()
complain_no_main DynFlags
dflags Module
main_mod OccName
main_occ
      = Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (Bool
interactive Bool -> Bool -> Bool
&& Bool -> Bool
not Bool
explicit_mod_hdr) (IOEnv (Env TcGblEnv TcLclEnv) ()
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
        TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErrTc (Module -> OccName -> TcRnMessage
noMainMsg Module
main_mod OccName
main_occ)          -- #12906
      where
        interactive :: Bool
interactive = DynFlags -> GhcLink
ghcLink DynFlags
dflags GhcLink -> GhcLink -> Bool
forall a. Eq a => a -> a -> Bool
== GhcLink
LinkInMemory
        -- Without an explicit module header...
        -- in interactive mode, don't worry about the absence of 'main'.
        -- in other modes, add error message and go on with typechecking.

    noMainMsg :: Module -> OccName -> TcRnMessage
noMainMsg Module
main_mod OccName
main_occ
      = Bool -> Module -> OccName -> TcRnMessage
TcRnMissingMain Bool
explicit_export_list Module
main_mod OccName
main_occ
    explicit_export_list :: Bool
explicit_export_list = Bool
explicit_mod_hdr Bool -> Bool -> Bool
&& Maybe (GenLocated SrcSpanAnnL [GenLocated SrcSpanAnnA (IE GhcPs)])
-> Bool
forall a. Maybe a -> Bool
isJust Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
Maybe (GenLocated SrcSpanAnnL [GenLocated SrcSpanAnnA (IE GhcPs)])
export_ies

-- | Get the unqualified name of the function to use as the \"main\" for the main module.
-- Either returns the default name or the one configured on the command line with -main-is
getMainOcc :: DynFlags -> OccName
getMainOcc :: DynFlags -> OccName
getMainOcc DynFlags
dflags = case DynFlags -> Maybe String
mainFunIs DynFlags
dflags of
                      Just String
fn -> FastString -> OccName
mkVarOccFS (String -> FastString
mkFastString String
fn)
                      Maybe String
Nothing -> FastString -> OccName
mkVarOccFS (String -> FastString
fsLit String
"main")

generateMainBinding :: TcGblEnv -> Name -> TcM TcGblEnv
-- There is a single exported 'main' function, called 'foo' (say),
-- which may be locally defined or imported
-- Define and typecheck the binding
--     :Main.main :: IO res_ty = runMainIO res_ty foo
-- This wraps the user's main function in the top-level stuff
-- defined in runMainIO (eg catching otherwise un-caught exceptions)
-- See Note [Dealing with main]
generateMainBinding :: TcGblEnv -> Name -> TcM TcGblEnv
generateMainBinding TcGblEnv
tcg_env Name
main_name = do
    { String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"checkMain found" (Name -> SDoc
forall a. Outputable a => a -> SDoc
ppr Name
main_name)
    ; (Type
io_ty, Type
res_ty) <- TcM (Type, Type)
getIOType
    ; let loc :: SrcSpan
loc = Name -> SrcSpan
forall a. NamedThing a => a -> SrcSpan
getSrcSpan Name
main_name
          main_expr_rn :: GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
main_expr_rn = SrcSpanAnnA
-> HsExpr (GhcPass 'Renamed)
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
forall l e. l -> e -> GenLocated l e
L (SrcSpan -> SrcSpanAnnA
forall ann. SrcSpan -> SrcAnn ann
noAnnSrcSpan SrcSpan
loc) (XVar (GhcPass 'Renamed)
-> LIdP (GhcPass 'Renamed) -> HsExpr (GhcPass 'Renamed)
forall p. XVar p -> LIdP p -> HsExpr p
HsVar XVar (GhcPass 'Renamed)
NoExtField
noExtField (SrcSpanAnnN -> Name -> GenLocated SrcSpanAnnN Name
forall l e. l -> e -> GenLocated l e
L (SrcSpan -> SrcSpanAnnN
forall ann. SrcSpan -> SrcAnn ann
noAnnSrcSpan SrcSpan
loc) Name
main_name))
    ; (TcEvBinds
ev_binds, GenLocated SrcSpanAnnA (HsExpr GhcTc)
main_expr) <- Name
-> Type -> TcM (LHsExpr GhcTc) -> TcM (TcEvBinds, LHsExpr GhcTc)
forall a. Name -> Type -> TcM a -> TcM (TcEvBinds, a)
setMainCtxt Name
main_name Type
io_ty (TcM (LHsExpr GhcTc) -> TcM (TcEvBinds, LHsExpr GhcTc))
-> TcM (LHsExpr GhcTc) -> TcM (TcEvBinds, LHsExpr GhcTc)
forall a b. (a -> b) -> a -> b
$
                               LHsExpr (GhcPass 'Renamed) -> Type -> TcM (LHsExpr GhcTc)
tcCheckMonoExpr LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
main_expr_rn Type
io_ty

            -- See Note [Root-main Id]
            -- Construct the binding
            --      :Main.main :: IO res_ty = runMainIO res_ty main
    ; Var
run_main_id <- Name -> TcM Var
tcLookupId Name
runMainIOName
    ; let { root_main_name :: Name
root_main_name =  Unique -> Module -> OccName -> SrcSpan -> Name
mkExternalName Unique
rootMainKey Module
rOOT_MAIN
                               (FastString -> OccName
mkVarOccFS (String -> FastString
fsLit String
"main"))
                               (Name -> SrcSpan
forall a. NamedThing a => a -> SrcSpan
getSrcSpan Name
main_name)
          ; root_main_id :: Var
root_main_id = Name -> Type -> Var
Id.mkExportedVanillaId Name
root_main_name Type
io_ty
          ; co :: HsWrapper
co  = [Type] -> HsWrapper
mkWpTyApps [Type
res_ty]
          -- The ev_binds of the `main` function may contain deferred
          -- type errors when type of `main` is not `IO a`. The `ev_binds`
          -- must be put inside `runMainIO` to ensure the deferred type
          -- error can be emitted correctly. See #13838.
          ; rhs :: LHsExpr GhcTc
rhs = LHsExpr GhcTc -> LHsExpr GhcTc -> LHsExpr GhcTc
forall (id :: Pass).
IsPass id =>
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
nlHsApp (HsWrapper -> LHsExpr GhcTc -> LHsExpr GhcTc
mkLHsWrap HsWrapper
co (IdP GhcTc -> LHsExpr GhcTc
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP GhcTc
Var
run_main_id)) (LHsExpr GhcTc -> LHsExpr GhcTc) -> LHsExpr GhcTc -> LHsExpr GhcTc
forall a b. (a -> b) -> a -> b
$
                    TcEvBinds -> LHsExpr GhcTc -> LHsExpr GhcTc
mkHsDictLet TcEvBinds
ev_binds LHsExpr GhcTc
GenLocated SrcSpanAnnA (HsExpr GhcTc)
main_expr
          ; main_bind :: LHsBind GhcTc
main_bind = IdP GhcTc -> LHsExpr GhcTc -> LHsBind GhcTc
mkVarBind IdP GhcTc
Var
root_main_id LHsExpr GhcTc
rhs }

    ; TcGblEnv -> TcM TcGblEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv
tcg_env { tcg_main  = Just main_name
                      , tcg_binds = tcg_binds tcg_env
                                    `snocBag` main_bind
                      , tcg_dus   = tcg_dus tcg_env
                                    `plusDU` usesOnly (unitFV main_name) })
                    -- Record the use of 'main', so that we don't
                    -- complain about it being defined but not used
    }

getIOType :: TcM (TcType, TcType)
-- Return (IO alpha, alpha) for fresh alpha
getIOType :: TcM (Type, Type)
getIOType = do { TyCon
ioTyCon <- Name -> TcM TyCon
tcLookupTyCon Name
ioTyConName
               ; Type
res_ty <- Type -> TcM Type
newFlexiTyVarTy Type
liftedTypeKind
               ; (Type, Type) -> TcM (Type, Type)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TyCon -> [Type] -> Type
mkTyConApp TyCon
ioTyCon [Type
res_ty], Type
res_ty) }

setMainCtxt :: Name -> TcType -> TcM a -> TcM (TcEvBinds, a)
setMainCtxt :: forall a. Name -> Type -> TcM a -> TcM (TcEvBinds, a)
setMainCtxt Name
main_name Type
io_ty TcM a
thing_inside
  = SrcSpan -> TcRn (TcEvBinds, a) -> TcRn (TcEvBinds, a)
forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan (Name -> SrcSpan
forall a. NamedThing a => a -> SrcSpan
getSrcSpan Name
main_name) (TcRn (TcEvBinds, a) -> TcRn (TcEvBinds, a))
-> TcRn (TcEvBinds, a) -> TcRn (TcEvBinds, a)
forall a b. (a -> b) -> a -> b
$
    SDoc -> TcRn (TcEvBinds, a) -> TcRn (TcEvBinds, a)
forall a. SDoc -> TcM a -> TcM a
addErrCtxt SDoc
main_ctxt              (TcRn (TcEvBinds, a) -> TcRn (TcEvBinds, a))
-> TcRn (TcEvBinds, a) -> TcRn (TcEvBinds, a)
forall a b. (a -> b) -> a -> b
$
    SkolemInfoAnon -> [Var] -> [Var] -> TcM a -> TcRn (TcEvBinds, a)
forall result.
SkolemInfoAnon
-> [Var] -> [Var] -> TcM result -> TcM (TcEvBinds, result)
checkConstraints SkolemInfoAnon
skol_info [] []  (TcM a -> TcRn (TcEvBinds, a)) -> TcM a -> TcRn (TcEvBinds, a)
forall a b. (a -> b) -> a -> b
$  -- Builds an implication if necessary
    TcM a
thing_inside                         -- e.g. with -fdefer-type-errors
  where
    skol_info :: SkolemInfoAnon
skol_info = UserTypeCtxt -> Type -> [(Name, Var)] -> SkolemInfoAnon
SigSkol (Name -> ReportRedundantConstraints -> UserTypeCtxt
FunSigCtxt Name
main_name ReportRedundantConstraints
NoRRC) Type
io_ty []
    main_ctxt :: SDoc
main_ctxt = String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"When checking the type of the"
                SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> OccName -> SDoc
ppMainFn (Name -> OccName
nameOccName Name
main_name)

{- Note [Dealing with main]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Dealing with the 'main' declaration is surprisingly tricky. Here are
the moving parts:

* The flag -main-is=M.foo allows you to set the main module to 'M',
  and the main function to 'foo'.  We access them through
      mainModIs  :: HscEnv -> Module     -- returns M
      getMainOcc :: DynFlags -> OccName  -- returns foo
  Of course usually M = Main, and foo = main.

* checkMainType: when typechecking module M, we add an extra check that
    foo :: IO tau, for some type tau.
  This avoids getting ambiguous-type errors from the monomorphism restriction
  applying to things like
      main = return ()
  Note that checkMainType does not consult the export list because
  we have not yet done rnExports (and can't do it until later).

* rnExports: checks the export list.  Very annoyingly, we can only do
  this after running any finalisers, which may add new declarations.
  That's why checkMainType and checkMain have to be separate.

* checkMain: does two things:
  - check that the export list does indeed export something called 'foo'
  - generateMainBinding: generate the root-main binding
       :Main.main = runMainIO M.foo
  See Note [Root-main Id]

An annoying consequence of having both checkMainType and checkMain is
that, when (but only when) -fdefer-type-errors is on, we may report an
ill-typed 'main' twice (as warnings): once in checkMainType and once
in checkMain. See test typecheck/should_fail/T13292.

We have the following tests to check this processing:
----------------+----------------------------------------------------------------------------------+
                |                                  Module Header:                                  |
                +-------------+-------------+-------------+-------------+-------------+------------+
                | module      | module Main | <No Header> | module Main |module       |module Main |
                |  Main(main) |             |             |   (module X)|   Main ()   |  (Sub.main)|
----------------+==================================================================================+
`main` function | ERROR:      | Main.main   | ERROR:      | Main.main   | ERROR:      | Sub.main   |
in Main module  |  Ambiguous  |             |  Ambiguous  |             |  `main` not |            |
and in imported |             |             |             |             |  exported   |            |
module Sub.     | T19397E1    | T16453M0    | T19397E2    | T16453M3    |             | T16453M1   |
                |             |             |             | X = Main    | Remark 2)   |            |
----------------+-------------+-------------+-------------+-------------+-------------+------------+
`main`function  | Sub.main    | ERROR:      | Sub.main    | Sub.main    | ERROR:      | Sub.main   |
only in imported|             | No `main` in|             |             |  `main` not |            |
submodule Sub.  |             |   `Main`    |             |             |  exported   |            |
                | T19397M0    | T16453E1    | T19397M1    | T16453M4    |             | T16453M5   |
                |             |             |             | X = Sub     | Remark 2)   |            |
----------------+-------------+-------------+-------------+-------------+-------------+------------+
`foo` function  | Sub.foo     | ERROR:      | Sub.foo     | Sub.foo     | ERROR:      | Sub.foo    |
in submodule    |             | No `foo` in |             |             |  `foo` not  |            |
Sub.            |             |   `Main`    |             |             |  exported   |            |
GHC option:     |             |             |             |             |             |            |
  -main-is foo  | T19397M2    | T19397E3    | T19397M3    | T19397M4    | T19397E4    | T16453M6   |
                | Remark 1)   |             |             | X = Sub     |             | Remark 3)  |
----------------+-------------+-------------+-------------+-------------+-------------+------------+

Remarks:
* The first line shows the exported `main` function or the error.
* The second line shows the coresponding test case.
* The module `Sub` contains the following functions:
     main :: IO ()
     foo :: IO ()
* Remark 1) Here the header is `Main (foo)`.
* Remark 2) Here we have no extra test case. It would exercise the same code path as `T19397E4`.
* Remark 3) Here the header is `Main (Sub.foo)`.


Note [Root-main Id]
~~~~~~~~~~~~~~~~~~~
The function that the RTS invokes is always :Main.main, which we call
root_main_id.  (Because GHC allows the user to have a module not
called Main as the main module, we can't rely on the main function
being called "Main.main".  That's why root_main_id has a fixed module
":Main".)

This is unusual: it's a LocalId whose Name has a Module from another
module. Tiresomely, we must filter it out again in GHC.Iface.Make, less we
get two defns for 'main' in the interface file!

When using `-fwrite-if-simplified-core` the root_main_id can end up in an interface file.
When the interface is read back in we have to add a special case when creating the
Id because otherwise we would go looking for the :Main module which obviously doesn't
exist. For this logic see GHC.IfaceToCore.mk_top_id.

There is also some similar (probably dead) logic in GHC.Rename.Env which says it
was added for External Core which faced a similar issue.


*********************************************************
*                                                       *
                GHCi stuff
*                                                       *
*********************************************************
-}

runTcInteractive :: HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
-- Initialise the tcg_inst_env with instances from all home modules.
-- This mimics the more selective call to hptInstances in tcRnImports
runTcInteractive :: forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env TcRn a
thing_inside
  = HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
initTcInteractive HscEnv
hsc_env (TcRn a -> IO (Messages TcRnMessage, Maybe a))
-> TcRn a -> IO (Messages TcRnMessage, Maybe a)
forall a b. (a -> b) -> a -> b
$ HscEnv -> TcRn a -> TcRn a
forall a. HscEnv -> TcM a -> TcM a
withTcPlugins HscEnv
hsc_env (TcRn a -> TcRn a) -> TcRn a -> TcRn a
forall a b. (a -> b) -> a -> b
$
    HscEnv -> TcRn a -> TcRn a
forall a. HscEnv -> TcM a -> TcM a
withDefaultingPlugins HscEnv
hsc_env (TcRn a -> TcRn a) -> TcRn a -> TcRn a
forall a b. (a -> b) -> a -> b
$ HscEnv -> TcRn a -> TcRn a
forall a. HscEnv -> TcM a -> TcM a
withHoleFitPlugins HscEnv
hsc_env (TcRn a -> TcRn a) -> TcRn a -> TcRn a
forall a b. (a -> b) -> a -> b
$
    do { String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"setInteractiveContext" (SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
            [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat [ String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"ic_tythings:" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat ((TyThing -> SDoc) -> [TyThing] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map TyThing -> SDoc
forall a. Outputable a => a -> SDoc
ppr (InteractiveContext -> [TyThing]
ic_tythings InteractiveContext
icxt))
                 , String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"ic_insts:" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat ((ClsInst -> SDoc) -> [ClsInst] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (BindingSite -> Var -> SDoc
forall a. OutputableBndr a => BindingSite -> a -> SDoc
pprBndr BindingSite
LetBind (Var -> SDoc) -> (ClsInst -> Var) -> ClsInst -> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ClsInst -> Var
instanceDFunId) (InstEnv -> [ClsInst]
instEnvElts InstEnv
ic_insts))
                 , String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"icReaderEnv (LocalDef)" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+>
                      [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat (([GlobalRdrElt] -> SDoc) -> [[GlobalRdrElt]] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map [GlobalRdrElt] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [ [GlobalRdrElt]
local_gres | [GlobalRdrElt]
gres <- GlobalRdrEnv -> [[GlobalRdrElt]]
forall a. OccEnv a -> [a]
nonDetOccEnvElts (InteractiveContext -> GlobalRdrEnv
icReaderEnv InteractiveContext
icxt)
                                                 , let local_gres :: [GlobalRdrElt]
local_gres = (GlobalRdrElt -> Bool) -> [GlobalRdrElt] -> [GlobalRdrElt]
forall a. (a -> Bool) -> [a] -> [a]
filter GlobalRdrElt -> Bool
forall info. GlobalRdrEltX info -> Bool
isLocalGRE [GlobalRdrElt]
gres
                                                 , Bool -> Bool
not ([GlobalRdrElt] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [GlobalRdrElt]
local_gres) ]) ]

       ; let getOrphans :: ModuleName -> PkgQual -> IOEnv (Env TcGblEnv TcLclEnv) [Module]
getOrphans ModuleName
m PkgQual
mb_pkg = (ModIface_ 'ModIfaceFinal -> [Module])
-> IOEnv (Env TcGblEnv TcLclEnv) (ModIface_ 'ModIfaceFinal)
-> IOEnv (Env TcGblEnv TcLclEnv) [Module]
forall a b.
(a -> b)
-> IOEnv (Env TcGblEnv TcLclEnv) a
-> IOEnv (Env TcGblEnv TcLclEnv) b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\ModIface_ 'ModIfaceFinal
iface -> ModIface_ 'ModIfaceFinal -> Module
forall (phase :: ModIfacePhase). ModIface_ phase -> Module
mi_module ModIface_ 'ModIfaceFinal
iface
                                          Module -> [Module] -> [Module]
forall a. a -> [a] -> [a]
: Dependencies -> [Module]
dep_orphs (ModIface_ 'ModIfaceFinal -> Dependencies
forall (phase :: ModIfacePhase). ModIface_ phase -> Dependencies
mi_deps ModIface_ 'ModIfaceFinal
iface))
                                 (SDoc
-> ModuleName
-> IsBootInterface
-> PkgQual
-> IOEnv (Env TcGblEnv TcLclEnv) (ModIface_ 'ModIfaceFinal)
loadSrcInterface (String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"runTcInteractive") ModuleName
m
                                                   IsBootInterface
NotBoot PkgQual
mb_pkg)

       ; ![Module]
orphs <- ([[Module]] -> [Module])
-> IOEnv (Env TcGblEnv TcLclEnv) [[Module]]
-> IOEnv (Env TcGblEnv TcLclEnv) [Module]
forall a b.
(a -> b)
-> IOEnv (Env TcGblEnv TcLclEnv) a
-> IOEnv (Env TcGblEnv TcLclEnv) b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap ([Module] -> [Module]
forall a. NFData a => a -> a
force ([Module] -> [Module])
-> ([[Module]] -> [Module]) -> [[Module]] -> [Module]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [[Module]] -> [Module]
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat) (IOEnv (Env TcGblEnv TcLclEnv) [[Module]]
 -> IOEnv (Env TcGblEnv TcLclEnv) [Module])
-> ((InteractiveImport -> IOEnv (Env TcGblEnv TcLclEnv) [Module])
    -> IOEnv (Env TcGblEnv TcLclEnv) [[Module]])
-> (InteractiveImport -> IOEnv (Env TcGblEnv TcLclEnv) [Module])
-> IOEnv (Env TcGblEnv TcLclEnv) [Module]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [InteractiveImport]
-> (InteractiveImport -> IOEnv (Env TcGblEnv TcLclEnv) [Module])
-> IOEnv (Env TcGblEnv TcLclEnv) [[Module]]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
t a -> (a -> m b) -> m (t b)
forM (InteractiveContext -> [InteractiveImport]
ic_imports InteractiveContext
icxt) ((InteractiveImport -> IOEnv (Env TcGblEnv TcLclEnv) [Module])
 -> IOEnv (Env TcGblEnv TcLclEnv) [Module])
-> (InteractiveImport -> IOEnv (Env TcGblEnv TcLclEnv) [Module])
-> IOEnv (Env TcGblEnv TcLclEnv) [Module]
forall a b. (a -> b) -> a -> b
$ \InteractiveImport
i ->
            case InteractiveImport
i of                   -- force above: see #15111
                IIModule ModuleName
n -> ModuleName -> PkgQual -> IOEnv (Env TcGblEnv TcLclEnv) [Module]
getOrphans ModuleName
n PkgQual
NoPkgQual
                IIDecl ImportDecl GhcPs
i   -> ModuleName -> PkgQual -> IOEnv (Env TcGblEnv TcLclEnv) [Module]
getOrphans (GenLocated SrcSpanAnnA ModuleName -> ModuleName
forall l e. GenLocated l e -> e
unLoc (ImportDecl GhcPs -> XRec GhcPs ModuleName
forall pass. ImportDecl pass -> XRec pass ModuleName
ideclName ImportDecl GhcPs
i))
                                         (UnitEnv -> ModuleName -> RawPkgQual -> PkgQual
renameRawPkgQual (HscEnv -> UnitEnv
hsc_unit_env HscEnv
hsc_env) (GenLocated SrcSpanAnnA ModuleName -> ModuleName
forall l e. GenLocated l e -> e
unLoc (GenLocated SrcSpanAnnA ModuleName -> ModuleName)
-> GenLocated SrcSpanAnnA ModuleName -> ModuleName
forall a b. (a -> b) -> a -> b
$ ImportDecl GhcPs -> XRec GhcPs ModuleName
forall pass. ImportDecl pass -> XRec pass ModuleName
ideclName ImportDecl GhcPs
i) (ImportDecl GhcPs -> ImportDeclPkgQual GhcPs
forall pass. ImportDecl pass -> ImportDeclPkgQual pass
ideclPkgQual ImportDecl GhcPs
i))

       ; let imports :: ImportAvails
imports = ImportAvails
emptyImportAvails { imp_orphs = orphs }

             upd_envs :: (TcGblEnv, TcLclEnv) -> (TcGblEnv, TcLclEnv)
upd_envs (TcGblEnv
gbl_env, TcLclEnv
lcl_env) = (TcGblEnv
gbl_env', TcLclEnv
lcl_env')

               where
                 gbl_env' :: TcGblEnv
gbl_env' = TcGblEnv
gbl_env
                   { tcg_rdr_env      = icReaderEnv icxt
                   , tcg_type_env     = type_env
                   , tcg_inst_env     = tcg_inst_env gbl_env `unionInstEnv` ic_insts `unionInstEnv` home_insts
                   , tcg_fam_inst_env = extendFamInstEnvList
                              (extendFamInstEnvList (tcg_fam_inst_env gbl_env)
                                                    ic_finsts)
                              home_fam_insts
                   , tcg_fix_env      = ic_fix_env icxt
                   , tcg_default      = ic_default icxt
                        -- must calculate imp_orphs of the ImportAvails
                        -- so that instance visibility is done correctly
                   , tcg_imports      = imports }

                 lcl_env' :: TcLclEnv
lcl_env' = (TcLclCtxt -> TcLclCtxt) -> TcLclEnv -> TcLclEnv
modifyLclCtxt ([(Name, TcTyThing)] -> TcLclCtxt -> TcLclCtxt
tcExtendLocalTypeEnv [(Name, TcTyThing)]
lcl_ids) TcLclEnv
lcl_env

       ; ((TcGblEnv, TcLclEnv) -> (TcGblEnv, TcLclEnv)) -> TcRn a -> TcRn a
forall gbl lcl a.
((gbl, lcl) -> (gbl, lcl)) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
updEnvs (TcGblEnv, TcLclEnv) -> (TcGblEnv, TcLclEnv)
upd_envs TcRn a
thing_inside }
  where
    (InstEnv
home_insts, [FamInst]
home_fam_insts) = HscEnv -> (InstEnv, [FamInst])
hptAllInstances HscEnv
hsc_env

    icxt :: InteractiveContext
icxt                     = HscEnv -> InteractiveContext
hsc_IC HscEnv
hsc_env
    (InstEnv
ic_insts, [FamInst]
ic_finsts)    = InteractiveContext -> (InstEnv, [FamInst])
ic_instances InteractiveContext
icxt
    ([(Name, TcTyThing)]
lcl_ids, [TyThing]
top_ty_things) = (TyThing -> Either (Name, TcTyThing) TyThing)
-> [TyThing] -> ([(Name, TcTyThing)], [TyThing])
forall a b c. (a -> Either b c) -> [a] -> ([b], [c])
partitionWith TyThing -> Either (Name, TcTyThing) TyThing
is_closed (InteractiveContext -> [TyThing]
ic_tythings InteractiveContext
icxt)

    is_closed :: TyThing -> Either (Name, TcTyThing) TyThing
    -- Put Ids with free type variables (always RuntimeUnks)
    -- in the *local* type environment
    -- See Note [Initialising the type environment for GHCi]
    is_closed :: TyThing -> Either (Name, TcTyThing) TyThing
is_closed TyThing
thing
      | AnId Var
id <- TyThing
thing
      , Bool -> Bool
not (Var -> Bool
isTypeClosedLetBndr Var
id)
      = (Name, TcTyThing) -> Either (Name, TcTyThing) TyThing
forall a b. a -> Either a b
Left (Var -> Name
idName Var
id, ATcId { tct_id :: Var
tct_id = Var
id
                               , tct_info :: IdBindingInfo
tct_info = IdBindingInfo
NotLetBound })
      | Bool
otherwise
      = TyThing -> Either (Name, TcTyThing) TyThing
forall a b. b -> Either a b
Right TyThing
thing

    type_env1 :: TypeEnv
type_env1 = [TyThing] -> TypeEnv
mkTypeEnvWithImplicits [TyThing]
top_ty_things
    type_env :: TypeEnv
type_env  = TypeEnv -> [Var] -> TypeEnv
extendTypeEnvWithIds TypeEnv
type_env1
              ([Var] -> TypeEnv) -> [Var] -> TypeEnv
forall a b. (a -> b) -> a -> b
$ (ClsInst -> Var) -> [ClsInst] -> [Var]
forall a b. (a -> b) -> [a] -> [b]
map ClsInst -> Var
instanceDFunId (InstEnv -> [ClsInst]
instEnvElts InstEnv
ic_insts)
                -- Putting the dfuns in the type_env
                -- is just to keep Core Lint happy

{- Note [Initialising the type environment for GHCi]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Most of the Ids in ic_things, defined by the user in 'let' stmts,
have closed types. E.g.
   ghci> let foo x y = x && not y

However the GHCi debugger creates top-level bindings for Ids whose
types have free RuntimeUnk skolem variables, standing for unknown
types.  If we don't register these free TyVars as global TyVars then
the typechecker will try to quantify over them and fall over in
skolemiseQuantifiedTyVar. so we must add any free TyVars to the
typechecker's global TyVar set.  That is done by using
tcExtendLocalTypeEnv.

We do this by splitting out the Ids with open types, using 'is_closed'
to do the partition.  The top-level things go in the global TypeEnv;
the open, NotTopLevel, Ids, with free RuntimeUnk tyvars, go in the
local TypeEnv.

Note that we don't extend the local RdrEnv (tcl_rdr); all the in-scope
things are already in the interactive context's GlobalRdrEnv.
Extending the local RdrEnv isn't terrible, but it means there is an
entry for the same Name in both global and local RdrEnvs, and that
lead to duplicate "perhaps you meant..." suggestions (e.g. T5564).

We don't bother with the tcl_th_bndrs environment either.
-}

-- | The returned [Id] is the list of new Ids bound by this statement. It can
-- be used to extend the InteractiveContext via extendInteractiveContext.
--
-- The returned TypecheckedHsExpr is of type IO [ Any ], a list of the bound
-- values, coerced to Any.
tcRnStmt :: HscEnv -> GhciLStmt GhcPs
         -> IO (Messages TcRnMessage, Maybe ([Id], LHsExpr GhcTc, FixityEnv))
tcRnStmt :: HscEnv
-> GhciLStmt GhcPs
-> IO
     (Messages TcRnMessage, Maybe ([Var], LHsExpr GhcTc, FixityEnv))
tcRnStmt HscEnv
hsc_env GhciLStmt GhcPs
rdr_stmt
  = HscEnv
-> TcRn ([Var], LHsExpr GhcTc, FixityEnv)
-> IO
     (Messages TcRnMessage, Maybe ([Var], LHsExpr GhcTc, FixityEnv))
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcRn ([Var], LHsExpr GhcTc, FixityEnv)
 -> IO
      (Messages TcRnMessage, Maybe ([Var], LHsExpr GhcTc, FixityEnv)))
-> TcRn ([Var], LHsExpr GhcTc, FixityEnv)
-> IO
     (Messages TcRnMessage, Maybe ([Var], LHsExpr GhcTc, FixityEnv))
forall a b. (a -> b) -> a -> b
$ do {

    -- The real work is done here
    (([Var]
bound_ids, GenLocated SrcSpanAnnA (HsExpr GhcTc)
tc_expr), FixityEnv
fix_env) <- GhciLStmt GhcPs -> TcM (PlanResult, FixityEnv)
tcUserStmt GhciLStmt GhcPs
rdr_stmt ;
    GenLocated SrcSpanAnnA (HsExpr GhcTc)
zonked_expr <- LHsExpr GhcTc -> TcM (LHsExpr GhcTc)
zonkTopLExpr LHsExpr GhcTc
GenLocated SrcSpanAnnA (HsExpr GhcTc)
tc_expr ;
    [Var]
zonked_ids  <- [Var] -> TcM [Var]
zonkTopBndrs [Var]
bound_ids ;

    IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM ;  -- we can't do the next step if there are
                   -- representation polymorphism errors
                   -- test case: ghci/scripts/T13202{,a}

        -- None of the Ids should be of unboxed type, because we
        -- cast them all to HValues in the end!
    (Var -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> [Var] -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ (TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErr (TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> (Var -> TcRnMessage) -> Var -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Var -> TcRnMessage
TcRnGhciUnliftedBind) ([Var] -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> [Var] -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
      (Var -> Bool) -> [Var] -> [Var]
forall a. (a -> Bool) -> [a] -> [a]
filter (Type -> Bool
mightBeUnliftedType (Type -> Bool) -> (Var -> Type) -> Var -> Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Var -> Type
idType) [Var]
zonked_ids ;

    String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"tcs 1" SDoc
forall doc. IsOutput doc => doc
empty ;
    Module
this_mod <- IOEnv (Env TcGblEnv TcLclEnv) Module
forall (m :: * -> *). HasModule m => m Module
getModule ;
    [Var]
global_ids <- (Var -> TcM Var) -> [Var] -> TcM [Var]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> [a] -> m [b]
mapM (Module -> Var -> TcM Var
externaliseAndTidyId Module
this_mod) [Var]
zonked_ids ;
        -- Note [Interactively-bound Ids in GHCi] in GHC.Driver.Env

    DumpFlag -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceOptTcRn DumpFlag
Opt_D_dump_tc
        ([SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat [String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"Bound Ids" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> (Var -> SDoc) -> [Var] -> SDoc
forall a. (a -> SDoc) -> [a] -> SDoc
pprWithCommas Var -> SDoc
forall a. Outputable a => a -> SDoc
ppr [Var]
global_ids,
               String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"Typechecked expr" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> GenLocated SrcSpanAnnA (HsExpr GhcTc) -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenLocated SrcSpanAnnA (HsExpr GhcTc)
zonked_expr]) ;

    ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc), FixityEnv)
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc), FixityEnv)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ([Var]
global_ids, GenLocated SrcSpanAnnA (HsExpr GhcTc)
zonked_expr, FixityEnv
fix_env)
    }

{-
--------------------------------------------------------------------------
                Typechecking Stmts in GHCi

Here is the grand plan, implemented in tcUserStmt

        What you type                   The IO [HValue] that hscStmt returns
        -------------                   ------------------------------------
        let pat = expr          ==>     let pat = expr in return [coerce HVal x, coerce HVal y, ...]
                                        bindings: [x,y,...]

        pat <- expr             ==>     expr >>= \ pat -> return [coerce HVal x, coerce HVal y, ...]
                                        bindings: [x,y,...]

        expr (of IO type)       ==>     expr >>= \ it -> return [coerce HVal it]
          [NB: result not printed]      bindings: [it]

        expr (of non-IO type,   ==>     let it = expr in print it >> return [coerce HVal it]
          result showable)              bindings: [it]

        expr (of non-IO type,
          result not showable)  ==>     error
-}

-- | A plan is an attempt to lift some code into the IO monad.
type PlanResult = ([Id], LHsExpr GhcTc)
type Plan = TcM PlanResult

-- | Try the plans in order. If one fails (by raising an exn), try the next.
-- If one succeeds, take it.
runPlans :: NonEmpty Plan -> Plan
runPlans :: NonEmpty Plan -> Plan
runPlans = (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
 -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
 -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall a. (a -> a -> a) -> NonEmpty a -> a
forall (t :: * -> *) a. Foldable t => (a -> a -> a) -> t a -> a
foldr1 ((TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
 -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
 -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall a b c. (a -> b -> c) -> b -> a -> c
flip TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall r. TcM r -> TcM r -> TcM r
tryTcDiscardingErrs)

-- | Typecheck (and 'lift') a stmt entered by the user in GHCi into the
-- GHCi 'environment'.
--
-- By 'lift' and 'environment we mean that the code is changed to
-- execute properly in an IO monad. See Note [Interactively-bound Ids
-- in GHCi] in GHC.Driver.Env for more details. We do this lifting by trying
-- different ways ('plans') of lifting the code into the IO monad and
-- type checking each plan until one succeeds.
tcUserStmt :: GhciLStmt GhcPs -> TcM (PlanResult, FixityEnv)

-- An expression typed at the prompt is treated very specially
tcUserStmt :: GhciLStmt GhcPs -> TcM (PlanResult, FixityEnv)
tcUserStmt (L SrcSpanAnnA
loc (BodyStmt XBodyStmt GhcPs GhcPs (GenLocated SrcSpanAnnA (HsExpr GhcPs))
_ GenLocated SrcSpanAnnA (HsExpr GhcPs)
expr SyntaxExpr GhcPs
_ SyntaxExpr GhcPs
_))
  = do  { (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr, FreeVars
fvs) <- TcM (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)), FreeVars)
-> TcM
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)), FreeVars)
forall r. TcM r -> TcM r
checkNoErrs (LHsExpr GhcPs -> RnM (LHsExpr (GhcPass 'Renamed), FreeVars)
rnLExpr LHsExpr GhcPs
GenLocated SrcSpanAnnA (HsExpr GhcPs)
expr)

        ; DumpFlag
-> String -> DumpFormat -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
dumpOptTcRn DumpFlag
Opt_D_dump_rn_ast String
"Renamer" DumpFormat
FormatHaskell
            (BlankSrcSpan
-> BlankEpAnnotations
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> SDoc
forall a. Data a => BlankSrcSpan -> BlankEpAnnotations -> a -> SDoc
showAstData BlankSrcSpan
NoBlankSrcSpan BlankEpAnnotations
NoBlankEpAnnotations GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr)
               -- Don't try to typecheck if the renamer fails!
        ; GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
ghciStep <- TcM (LHsExpr (GhcPass 'Renamed))
IOEnv
  (Env TcGblEnv TcLclEnv)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
getGhciStepIO
        ; Unique
uniq <- TcRnIf TcGblEnv TcLclEnv Unique
forall gbl lcl. TcRnIf gbl lcl Unique
newUnique
        ; let loc' :: SrcSpanAnnN
loc' = SrcSpan -> SrcSpanAnnN
forall ann. SrcSpan -> SrcAnn ann
noAnnSrcSpan (SrcSpan -> SrcSpanAnnN) -> SrcSpan -> SrcSpanAnnN
forall a b. (a -> b) -> a -> b
$ SrcSpanAnnA -> SrcSpan
forall a. SrcSpanAnn' a -> SrcSpan
locA SrcSpanAnnA
loc
        ; Name
interPrintName <- TcRn Name
getInteractivePrintName
        ; let fresh_it :: Name
fresh_it  = Unique -> SrcSpan -> Name
itName Unique
uniq (SrcSpanAnnA -> SrcSpan
forall a. SrcSpanAnn' a -> SrcSpan
locA SrcSpanAnnA
loc)
              matches :: [GenLocated
   SrcSpanAnnA
   (Match
      (GhcPass 'Renamed)
      (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))]
matches   = [HsMatchContext (GhcPass 'Renamed)
-> [LPat (GhcPass 'Renamed)]
-> LHsExpr (GhcPass 'Renamed)
-> HsLocalBinds (GhcPass 'Renamed)
-> LMatch (GhcPass 'Renamed) (LHsExpr (GhcPass 'Renamed))
forall (p :: Pass).
IsPass p =>
HsMatchContext (GhcPass p)
-> [LPat (GhcPass p)]
-> LHsExpr (GhcPass p)
-> HsLocalBinds (GhcPass p)
-> LMatch (GhcPass p) (LHsExpr (GhcPass p))
mkMatch (LIdP (NoGhcTc (GhcPass 'Renamed))
-> HsMatchContext (GhcPass 'Renamed)
forall p. LIdP (NoGhcTc p) -> HsMatchContext p
mkPrefixFunRhs (SrcSpanAnnN -> Name -> GenLocated SrcSpanAnnN Name
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnN
loc' Name
fresh_it)) [] LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr
                                   HsLocalBinds (GhcPass 'Renamed)
forall (a :: Pass) (b :: Pass).
HsLocalBindsLR (GhcPass a) (GhcPass b)
emptyLocalBinds]
              -- [it = expr]
              the_bind :: GenLocated
  SrcSpanAnnA (HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed))
the_bind  = SrcSpanAnnA
-> HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed)
-> GenLocated
     SrcSpanAnnA (HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed)
 -> GenLocated
      SrcSpanAnnA (HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed)))
-> HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed)
-> GenLocated
     SrcSpanAnnA (HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$ (Origin
-> GenLocated SrcSpanAnnN Name
-> [LMatch (GhcPass 'Renamed) (LHsExpr (GhcPass 'Renamed))]
-> HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed)
mkTopFunBind Origin
FromSource
                                     (SrcSpanAnnN -> Name -> GenLocated SrcSpanAnnN Name
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnN
loc' Name
fresh_it) [LMatch (GhcPass 'Renamed) (LHsExpr (GhcPass 'Renamed))]
[GenLocated
   SrcSpanAnnA
   (Match
      (GhcPass 'Renamed)
      (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))]
matches)
                                         { fun_ext = fvs }
              -- Care here!  In GHCi the expression might have
              -- free variables, and they in turn may have free type variables
              -- (if we are at a breakpoint, say).  We must put those free vars

              -- [let it = expr]
              let_stmt :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
let_stmt  = SrcSpanAnnA
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (StmtLR
   (GhcPass 'Renamed)
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
 -> GenLocated
      SrcSpanAnnA
      (StmtLR
         (GhcPass 'Renamed)
         (GhcPass 'Renamed)
         (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall a b. (a -> b) -> a -> b
$ XLetStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> HsLocalBinds (GhcPass 'Renamed)
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall idL idR body.
XLetStmt idL idR body
-> HsLocalBindsLR idL idR -> StmtLR idL idR body
LetStmt XLetStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
EpAnn [AddEpAnn]
forall a. EpAnn a
noAnn (HsLocalBinds (GhcPass 'Renamed)
 -> StmtLR
      (GhcPass 'Renamed)
      (GhcPass 'Renamed)
      (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
-> HsLocalBinds (GhcPass 'Renamed)
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall a b. (a -> b) -> a -> b
$ XHsValBinds (GhcPass 'Renamed) (GhcPass 'Renamed)
-> HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
-> HsLocalBinds (GhcPass 'Renamed)
forall idL idR.
XHsValBinds idL idR
-> HsValBindsLR idL idR -> HsLocalBindsLR idL idR
HsValBinds XHsValBinds (GhcPass 'Renamed) (GhcPass 'Renamed)
EpAnn AnnList
forall a. EpAnn a
noAnn
                           (HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
 -> HsLocalBinds (GhcPass 'Renamed))
-> HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
-> HsLocalBinds (GhcPass 'Renamed)
forall a b. (a -> b) -> a -> b
$ XXValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
-> HsValBindsLR (GhcPass 'Renamed) (GhcPass 'Renamed)
forall idL idR. XXValBindsLR idL idR -> HsValBindsLR idL idR
XValBindsLR
                               ([(RecFlag, LHsBinds (GhcPass 'Renamed))]
-> [LSig (GhcPass 'Renamed)] -> NHsValBindsLR (GhcPass 'Renamed)
forall idL.
[(RecFlag, LHsBinds idL)]
-> [LSig (GhcPass 'Renamed)] -> NHsValBindsLR idL
NValBinds [(RecFlag
NonRecursive,GenLocated
  SrcSpanAnnA (HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed))
-> Bag
     (GenLocated
        SrcSpanAnnA (HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed)))
forall a. a -> Bag a
unitBag GenLocated
  SrcSpanAnnA (HsBindLR (GhcPass 'Renamed) (GhcPass 'Renamed))
the_bind)] [])

              -- [it <- e]
              bind_stmt :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
bind_stmt = SrcSpanAnnA
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (StmtLR
   (GhcPass 'Renamed)
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
 -> GenLocated
      SrcSpanAnnA
      (StmtLR
         (GhcPass 'Renamed)
         (GhcPass 'Renamed)
         (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall a b. (a -> b) -> a -> b
$ XBindStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> LPat (GhcPass 'Renamed)
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall idL idR body.
XBindStmt idL idR body -> LPat idL -> body -> StmtLR idL idR body
BindStmt
                                       (XBindStmtRn
                                          { xbsrn_bindOp :: SyntaxExpr (GhcPass 'Renamed)
xbsrn_bindOp = Name -> SyntaxExprRn
mkRnSyntaxExpr Name
bindIOName
                                          , xbsrn_failOp :: FailOperator (GhcPass 'Renamed)
xbsrn_failOp = FailOperator (GhcPass 'Renamed)
Maybe SyntaxExprRn
forall a. Maybe a
Nothing
                                          })
                                       (SrcSpanAnnA
-> Pat (GhcPass 'Renamed)
-> GenLocated SrcSpanAnnA (Pat (GhcPass 'Renamed))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (XVarPat (GhcPass 'Renamed)
-> LIdP (GhcPass 'Renamed) -> Pat (GhcPass 'Renamed)
forall p. XVarPat p -> LIdP p -> Pat p
VarPat XVarPat (GhcPass 'Renamed)
NoExtField
noExtField (SrcSpanAnnN -> Name -> GenLocated SrcSpanAnnN Name
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnN
loc' Name
fresh_it)))
                                       (LHsExpr (GhcPass 'Renamed)
-> LHsExpr (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (id :: Pass).
IsPass id =>
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
nlHsApp LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
ghciStep LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr)

              -- [; print it]
              print_it :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
print_it  = SrcSpanAnnA
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (StmtLR
   (GhcPass 'Renamed)
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
 -> GenLocated
      SrcSpanAnnA
      (StmtLR
         (GhcPass 'Renamed)
         (GhcPass 'Renamed)
         (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall a b. (a -> b) -> a -> b
$ XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> SyntaxExpr (GhcPass 'Renamed)
-> SyntaxExpr (GhcPass 'Renamed)
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall idL idR body.
XBodyStmt idL idR body
-> body -> SyntaxExpr idR -> SyntaxExpr idR -> StmtLR idL idR body
BodyStmt XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
NoExtField
noExtField
                                           (LHsExpr (GhcPass 'Renamed)
-> LHsExpr (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (id :: Pass).
IsPass id =>
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
nlHsApp (IdP (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP (GhcPass 'Renamed)
Name
interPrintName)
                                           (IdP (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP (GhcPass 'Renamed)
Name
fresh_it))
                                           (Name -> SyntaxExprRn
mkRnSyntaxExpr Name
thenIOName)
                                                  SyntaxExpr (GhcPass 'Renamed)
forall (p :: Pass). IsPass p => SyntaxExpr (GhcPass p)
noSyntaxExpr

              -- NewA
              no_it_a :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
no_it_a = SrcSpanAnnA
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (StmtLR
   (GhcPass 'Renamed)
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
 -> GenLocated
      SrcSpanAnnA
      (StmtLR
         (GhcPass 'Renamed)
         (GhcPass 'Renamed)
         (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall a b. (a -> b) -> a -> b
$ XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> SyntaxExpr (GhcPass 'Renamed)
-> SyntaxExpr (GhcPass 'Renamed)
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall idL idR body.
XBodyStmt idL idR body
-> body -> SyntaxExpr idR -> SyntaxExpr idR -> StmtLR idL idR body
BodyStmt XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
NoExtField
noExtField (IdP (GhcPass 'Renamed)
-> [LHsExpr (GhcPass 'Renamed)] -> LHsExpr (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> [LHsExpr (GhcPass p)] -> LHsExpr (GhcPass p)
nlHsApps IdP (GhcPass 'Renamed)
Name
bindIOName
                                       [LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr , IdP (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP (GhcPass 'Renamed)
Name
interPrintName])
                                       (Name -> SyntaxExprRn
mkRnSyntaxExpr Name
thenIOName)
                                       SyntaxExpr (GhcPass 'Renamed)
forall (p :: Pass). IsPass p => SyntaxExpr (GhcPass p)
noSyntaxExpr

              no_it_b :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
no_it_b = SrcSpanAnnA
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (StmtLR
   (GhcPass 'Renamed)
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
 -> GenLocated
      SrcSpanAnnA
      (StmtLR
         (GhcPass 'Renamed)
         (GhcPass 'Renamed)
         (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall a b. (a -> b) -> a -> b
$ XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> SyntaxExpr (GhcPass 'Renamed)
-> SyntaxExpr (GhcPass 'Renamed)
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall idL idR body.
XBodyStmt idL idR body
-> body -> SyntaxExpr idR -> SyntaxExpr idR -> StmtLR idL idR body
BodyStmt XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
NoExtField
noExtField (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr)
                                       (Name -> SyntaxExprRn
mkRnSyntaxExpr Name
thenIOName)
                                       SyntaxExpr (GhcPass 'Renamed)
forall (p :: Pass). IsPass p => SyntaxExpr (GhcPass p)
noSyntaxExpr

              no_it_c :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
no_it_c = SrcSpanAnnA
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (StmtLR
   (GhcPass 'Renamed)
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
 -> GenLocated
      SrcSpanAnnA
      (StmtLR
         (GhcPass 'Renamed)
         (GhcPass 'Renamed)
         (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall a b. (a -> b) -> a -> b
$ XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> SyntaxExpr (GhcPass 'Renamed)
-> SyntaxExpr (GhcPass 'Renamed)
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall idL idR body.
XBodyStmt idL idR body
-> body -> SyntaxExpr idR -> SyntaxExpr idR -> StmtLR idL idR body
BodyStmt XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
NoExtField
noExtField
                                      (LHsExpr (GhcPass 'Renamed)
-> LHsExpr (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (id :: Pass).
IsPass id =>
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
nlHsApp (IdP (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP (GhcPass 'Renamed)
Name
interPrintName) LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr)
                                      (Name -> SyntaxExprRn
mkRnSyntaxExpr Name
thenIOName)
                                      SyntaxExpr (GhcPass 'Renamed)
forall (p :: Pass). IsPass p => SyntaxExpr (GhcPass p)
noSyntaxExpr

              -- See Note [GHCi Plans]

              it_plans :: NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
it_plans =
                    -- Plan A
                    do { stuff :: ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
stuff@([Var
it_id], GenLocated SrcSpanAnnA (HsExpr GhcTc)
_) <- [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
bind_stmt, GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
print_it]
                       ; Type
it_ty <- ZonkM Type -> TcM Type
forall a. ZonkM a -> TcM a
liftZonkM (ZonkM Type -> TcM Type) -> ZonkM Type -> TcM Type
forall a b. (a -> b) -> a -> b
$ Type -> ZonkM Type
zonkTcType (Var -> Type
idType Var
it_id)
                       ; Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (Type -> Bool
isUnitTy Type
it_ty) IOEnv (Env TcGblEnv TcLclEnv) ()
forall env a. IOEnv env a
failM
                       ; ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
stuff } TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> [TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))]
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
forall a. a -> [a] -> NonEmpty a
:|

                        -- Plan B; a naked bind statement
                  [ [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
bind_stmt]

                        -- Plan C; check that the let-binding is typeable all by itself.
                        -- If not, fail; if so, try to print it.
                        -- The two-step process avoids getting two errors: one from
                        -- the expression itself, and one from the 'print it' part
                        -- This two-step story is very clunky, alas
                  , do { ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
_ <- TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall r. TcM r -> TcM r
checkNoErrs ([GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
let_stmt])
                                --- checkNoErrs defeats the error recovery of let-bindings
                       ; [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
let_stmt, GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
print_it] } ]

              -- Plans where we don't bind "it"
              no_it_plans :: NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
no_it_plans =
                [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
no_it_a] TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> [TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))]
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
forall a. a -> [a] -> NonEmpty a
:|
                [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
no_it_b] TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> [TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))]
-> [TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))]
forall a. a -> [a] -> [a]
:
                [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
no_it_c] TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> [TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))]
-> [TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))]
forall a. a -> [a] -> [a]
:
                []

        ; Bool
generate_it <- GeneralFlag -> TcRnIf TcGblEnv TcLclEnv Bool
forall gbl lcl. GeneralFlag -> TcRnIf gbl lcl Bool
goptM GeneralFlag
Opt_NoIt

        -- We disable `-fdefer-type-errors` in GHCi for naked expressions.
        -- See Note [Deferred type errors in GHCi]

        -- NB: The flag `-fdefer-type-errors` implies `-fdefer-type-holes`
        -- and `-fdefer-out-of-scope-variables`. However the flag
        -- `-fno-defer-type-errors` doesn't imply `-fdefer-type-holes` and
        -- `-fno-defer-out-of-scope-variables`. Thus the later two flags
        -- also need to be unset here.
        ; ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
plan <- GeneralFlag
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall gbl lcl a.
GeneralFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
unsetGOptM GeneralFlag
Opt_DeferTypeErrors (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
 -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall a b. (a -> b) -> a -> b
$
                  GeneralFlag
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall gbl lcl a.
GeneralFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
unsetGOptM GeneralFlag
Opt_DeferTypedHoles (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
 -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall a b. (a -> b) -> a -> b
$
                  GeneralFlag
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall gbl lcl a.
GeneralFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
unsetGOptM GeneralFlag
Opt_DeferOutOfScopeVariables (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
 -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall a b. (a -> b) -> a -> b
$
                    NonEmpty Plan -> Plan
runPlans (NonEmpty Plan -> Plan) -> NonEmpty Plan -> Plan
forall a b. (a -> b) -> a -> b
$ if Bool
generate_it
                                 then NonEmpty Plan
NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
no_it_plans
                                 else NonEmpty Plan
NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
it_plans

        ; DumpFlag
-> String -> DumpFormat -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
dumpOptTcRn DumpFlag
Opt_D_dump_tc_ast String
"Typechecker AST" DumpFormat
FormatHaskell
              (BlankSrcSpan
-> BlankEpAnnotations
-> ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> SDoc
forall a. Data a => BlankSrcSpan -> BlankEpAnnotations -> a -> SDoc
showAstData BlankSrcSpan
NoBlankSrcSpan BlankEpAnnotations
NoBlankEpAnnotations ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
plan)

        ; FixityEnv
fix_env <- TcRn FixityEnv
getFixityEnv
        ; (([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)), FixityEnv)
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)), FixityEnv)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
plan, FixityEnv
fix_env) }

{- Note [Deferred type errors in GHCi]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In GHCi, we ensure that type errors don't get deferred when type checking the
naked expressions. Deferring type errors here is unhelpful because the
expression gets evaluated right away anyway. It also would potentially emit
two redundant type-error warnings, one from each plan.

#14963 reveals another bug that when deferred type errors is enabled
in GHCi, any reference of imported/loaded variables (directly or indirectly)
in interactively issued naked expressions will cause ghc panic. See more
detailed discussion in #14963.

The interactively issued declarations, statements, as well as the modules
loaded into GHCi, are not affected. That means, for declaration, you could
have

    Prelude> :set -fdefer-type-errors
    Prelude> x :: IO (); x = putStrLn True
    <interactive>:14:26: warning: [-Wdeferred-type-errors]
        ? Couldn't match type ‘Bool’ with ‘[Char]’
          Expected type: String
            Actual type: Bool
        ? In the first argument of ‘putStrLn’, namely ‘True’
          In the expression: putStrLn True
          In an equation for ‘x’: x = putStrLn True

But for naked expressions, you will have

    Prelude> :set -fdefer-type-errors
    Prelude> putStrLn True
    <interactive>:2:10: error:
        ? Couldn't match type ‘Bool’ with ‘[Char]’
          Expected type: String
            Actual type: Bool
        ? In the first argument of ‘putStrLn’, namely ‘True’
          In the expression: putStrLn True
          In an equation for ‘it’: it = putStrLn True

    Prelude> let x = putStrLn True
    <interactive>:2:18: warning: [-Wdeferred-type-errors]
        ? Couldn't match type ‘Bool’ with ‘[Char]’
          Expected type: String
            Actual type: Bool
        ? In the first argument of ‘putStrLn’, namely ‘True’
          In the expression: putStrLn True
          In an equation for ‘x’: x = putStrLn True
-}

tcUserStmt rdr_stmt :: GhciLStmt GhcPs
rdr_stmt@(L SrcSpanAnnA
loc StmtLR GhcPs GhcPs (GenLocated SrcSpanAnnA (HsExpr GhcPs))
_)
  = do { (([GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
rn_stmt], FixityEnv
fix_env), FreeVars
fvs) <- TcM
  (([GenLocated
       SrcSpanAnnA
       (StmtLR
          (GhcPass 'Renamed)
          (GhcPass 'Renamed)
          (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))],
    FixityEnv),
   FreeVars)
-> TcM
     (([GenLocated
          SrcSpanAnnA
          (StmtLR
             (GhcPass 'Renamed)
             (GhcPass 'Renamed)
             (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))],
       FixityEnv),
      FreeVars)
forall r. TcM r -> TcM r
checkNoErrs (TcM
   (([GenLocated
        SrcSpanAnnA
        (StmtLR
           (GhcPass 'Renamed)
           (GhcPass 'Renamed)
           (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))],
     FixityEnv),
    FreeVars)
 -> TcM
      (([GenLocated
           SrcSpanAnnA
           (StmtLR
              (GhcPass 'Renamed)
              (GhcPass 'Renamed)
              (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))],
        FixityEnv),
       FreeVars))
-> TcM
     (([GenLocated
          SrcSpanAnnA
          (StmtLR
             (GhcPass 'Renamed)
             (GhcPass 'Renamed)
             (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))],
       FixityEnv),
      FreeVars)
-> TcM
     (([GenLocated
          SrcSpanAnnA
          (StmtLR
             (GhcPass 'Renamed)
             (GhcPass 'Renamed)
             (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))],
       FixityEnv),
      FreeVars)
forall a b. (a -> b) -> a -> b
$
           HsStmtContext (GhcPass 'Renamed)
-> (HsExpr GhcPs -> RnM (HsExpr (GhcPass 'Renamed), FreeVars))
-> [LStmt GhcPs (GenLocated SrcSpanAnnA (HsExpr GhcPs))]
-> ([Name] -> RnM (FixityEnv, FreeVars))
-> RnM
     (([LStmt
          (GhcPass 'Renamed)
          (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))],
       FixityEnv),
      FreeVars)
forall (body :: * -> *) thing.
AnnoBody body =>
HsStmtContext (GhcPass 'Renamed)
-> (body GhcPs -> RnM (body (GhcPass 'Renamed), FreeVars))
-> [LStmt GhcPs (LocatedA (body GhcPs))]
-> ([Name] -> RnM (thing, FreeVars))
-> RnM
     (([LStmt (GhcPass 'Renamed) (LocatedA (body (GhcPass 'Renamed)))],
       thing),
      FreeVars)
rnStmts (HsDoFlavour -> HsStmtContext (GhcPass 'Renamed)
forall p. HsDoFlavour -> HsStmtContext p
HsDoStmt HsDoFlavour
GhciStmtCtxt) HsExpr GhcPs -> RnM (HsExpr (GhcPass 'Renamed), FreeVars)
rnExpr [GhciLStmt GhcPs
LStmt GhcPs (GenLocated SrcSpanAnnA (HsExpr GhcPs))
rdr_stmt] (([Name] -> RnM (FixityEnv, FreeVars))
 -> RnM
      (([LStmt
           (GhcPass 'Renamed)
           (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))],
        FixityEnv),
       FreeVars))
-> ([Name] -> RnM (FixityEnv, FreeVars))
-> RnM
     (([LStmt
          (GhcPass 'Renamed)
          (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))],
       FixityEnv),
      FreeVars)
forall a b. (a -> b) -> a -> b
$ \[Name]
_ -> do
             FixityEnv
fix_env <- TcRn FixityEnv
getFixityEnv
             (FixityEnv, FreeVars) -> RnM (FixityEnv, FreeVars)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (FixityEnv
fix_env, FreeVars
emptyFVs)
            -- Don't try to typecheck if the renamer fails!
       ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceRn String
"tcRnStmt" ([SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat [GenLocated
  SrcSpanAnnA
  (StmtLR GhcPs GhcPs (GenLocated SrcSpanAnnA (HsExpr GhcPs)))
-> SDoc
forall a. Outputable a => a -> SDoc
ppr GhciLStmt GhcPs
GenLocated
  SrcSpanAnnA
  (StmtLR GhcPs GhcPs (GenLocated SrcSpanAnnA (HsExpr GhcPs)))
rdr_stmt, GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
-> SDoc
forall a. Outputable a => a -> SDoc
ppr GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
rn_stmt, FreeVars -> SDoc
forall a. Outputable a => a -> SDoc
ppr FreeVars
fvs])
       ; GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a.
(Outputable a, Data a) =>
a -> IOEnv (Env TcGblEnv TcLclEnv) ()
rnDump GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
rn_stmt ;

       ; GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
ghciStep <- TcM (LHsExpr (GhcPass 'Renamed))
IOEnv
  (Env TcGblEnv TcLclEnv)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
getGhciStepIO
       ; let gi_stmt :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
gi_stmt
               | (L SrcSpanAnnA
loc (BindStmt XBindStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
x LPat (GhcPass 'Renamed)
pat GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
expr)) <- GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
rn_stmt
                     = SrcSpanAnnA
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (StmtLR
   (GhcPass 'Renamed)
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
 -> GenLocated
      SrcSpanAnnA
      (StmtLR
         (GhcPass 'Renamed)
         (GhcPass 'Renamed)
         (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall a b. (a -> b) -> a -> b
$ XBindStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> LPat (GhcPass 'Renamed)
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall idL idR body.
XBindStmt idL idR body -> LPat idL -> body -> StmtLR idL idR body
BindStmt XBindStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
x LPat (GhcPass 'Renamed)
pat (LHsExpr (GhcPass 'Renamed)
-> LHsExpr (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (id :: Pass).
IsPass id =>
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
nlHsApp LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
ghciStep LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
expr)
               | Bool
otherwise = GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
rn_stmt

       ; Bool
opt_pr_flag <- GeneralFlag -> TcRnIf TcGblEnv TcLclEnv Bool
forall gbl lcl. GeneralFlag -> TcRnIf gbl lcl Bool
goptM GeneralFlag
Opt_PrintBindResult
       ; let print_result_plan :: Maybe (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
print_result_plan
               | Bool
opt_pr_flag                         -- The flag says "print result"
               , [IdP (GhcPass 'Renamed)
v] <- CollectFlag (GhcPass 'Renamed)
-> LStmt
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> [IdP (GhcPass 'Renamed)]
forall (idL :: Pass) (idR :: Pass) body.
CollectPass (GhcPass idL) =>
CollectFlag (GhcPass idL)
-> LStmtLR (GhcPass idL) (GhcPass idR) body -> [IdP (GhcPass idL)]
collectLStmtBinders CollectFlag (GhcPass 'Renamed)
forall p. CollectFlag p
CollNoDictBinders LStmt
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
gi_stmt  -- One binder
               = TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> Maybe (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
forall a. a -> Maybe a
Just (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
 -> Maybe (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> Maybe (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
forall a b. (a -> b) -> a -> b
$ GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
-> Name -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
mk_print_result_plan GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
gi_stmt IdP (GhcPass 'Renamed)
Name
v
               | Bool
otherwise = Maybe (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
forall a. Maybe a
Nothing

        -- The plans are:
        --      [stmt; print v]         if one binder and not v::()
        --      [stmt]                  otherwise
       ; ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
plan <- NonEmpty Plan -> Plan
runPlans (NonEmpty Plan -> Plan) -> NonEmpty Plan -> Plan
forall a b. (a -> b) -> a -> b
$ (NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
 -> NonEmpty Plan)
-> (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
    -> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
    -> NonEmpty Plan)
-> Maybe (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> NonEmpty Plan
forall b a. b -> (a -> b) -> Maybe a -> b
maybe NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> NonEmpty Plan
NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
forall a. a -> a
id TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> NonEmpty Plan
TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
forall a. a -> NonEmpty a -> NonEmpty a
(NE.<|) Maybe (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
print_result_plan (NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
 -> NonEmpty Plan)
-> NonEmpty (TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)))
-> NonEmpty Plan
forall a b. (a -> b) -> a -> b
$ Plan -> NonEmpty Plan
forall a. a -> NonEmpty a
NE.singleton (Plan -> NonEmpty Plan) -> Plan -> NonEmpty Plan
forall a b. (a -> b) -> a -> b
$ [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
gi_stmt]
       ; (([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)), FixityEnv)
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc)), FixityEnv)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
plan, FixityEnv
fix_env) }
  where
    mk_print_result_plan :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
-> Name -> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
mk_print_result_plan GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
stmt Name
v
      = do { stuff :: ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
stuff@([Var
v_id], GenLocated SrcSpanAnnA (HsExpr GhcTc)
_) <- [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
stmt, GhciLStmt (GhcPass 'Renamed)
GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
print_v]
           ; Type
v_ty <- ZonkM Type -> TcM Type
forall a. ZonkM a -> TcM a
liftZonkM (ZonkM Type -> TcM Type) -> ZonkM Type -> TcM Type
forall a b. (a -> b) -> a -> b
$ Type -> ZonkM Type
zonkTcType (Var -> Type
idType Var
v_id)
           ; Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (Type -> Bool
isUnitTy Type
v_ty Bool -> Bool -> Bool
|| Bool -> Bool
not (Type -> Bool
isTauTy Type
v_ty)) IOEnv (Env TcGblEnv TcLclEnv) ()
forall env a. IOEnv env a
failM
           ; ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
stuff }
      where
        print_v :: GenLocated
  SrcSpanAnnA
  (StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
print_v  = SrcSpanAnnA
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc (StmtLR
   (GhcPass 'Renamed)
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
 -> GenLocated
      SrcSpanAnnA
      (StmtLR
         (GhcPass 'Renamed)
         (GhcPass 'Renamed)
         (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))))
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated
     SrcSpanAnnA
     (StmtLR
        (GhcPass 'Renamed)
        (GhcPass 'Renamed)
        (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))))
forall a b. (a -> b) -> a -> b
$ XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> SyntaxExpr (GhcPass 'Renamed)
-> SyntaxExpr (GhcPass 'Renamed)
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall idL idR body.
XBodyStmt idL idR body
-> body -> SyntaxExpr idR -> SyntaxExpr idR -> StmtLR idL idR body
BodyStmt XBodyStmt
  (GhcPass 'Renamed)
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
NoExtField
noExtField (LHsExpr (GhcPass 'Renamed)
-> LHsExpr (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (id :: Pass).
IsPass id =>
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
nlHsApp (IdP (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP (GhcPass 'Renamed)
Name
printName)
                                    (IdP (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP (GhcPass 'Renamed)
Name
v))
                                    (Name -> SyntaxExprRn
mkRnSyntaxExpr Name
thenIOName) SyntaxExpr (GhcPass 'Renamed)
forall (p :: Pass). IsPass p => SyntaxExpr (GhcPass p)
noSyntaxExpr

{-
Note [GHCi Plans]
~~~~~~~~~~~~~~~~~
When a user types an expression in the repl we try to print it in three different
ways. Also, depending on whether -fno-it is set, we bind a variable called `it`
which can be used to refer to the result of the expression subsequently in the repl.

The normal plans are :
  A. [it <- e; print e]     but not if it::()
  B. [it <- e]
  C. [let it = e; print it]

When -fno-it is set, the plans are:
  A. [e >>= print]
  B. [e]
  C. [let it = e in print it]

The reason for -fno-it is explained in #14336. `it` can lead to the repl
leaking memory as it is repeatedly queried.
-}

any_lifted :: Type
any_lifted :: Type
any_lifted = Type -> Type
anyTypeOfKind Type
liftedTypeKind

-- | Typecheck the statements given and then return the results of the
-- statement in the form 'IO [Any]'.
tcGhciStmts :: [GhciLStmt GhcRn] -> TcM PlanResult
tcGhciStmts :: [GhciLStmt (GhcPass 'Renamed)] -> Plan
tcGhciStmts [GhciLStmt (GhcPass 'Renamed)]
stmts
 = do { TyCon
ioTyCon <- Name -> TcM TyCon
tcLookupTyCon Name
ioTyConName
      ; Var
ret_id  <- Name -> TcM Var
tcLookupId Name
returnIOName             -- return @ IO
      ; let ret_ty :: Type
ret_ty      = Type -> Type
mkListTy Type
any_lifted
            io_ret_ty :: Type
io_ret_ty   = TyCon -> [Type] -> Type
mkTyConApp TyCon
ioTyCon [Type
ret_ty]
            tc_io_stmts :: (ExpType -> TcM [Var])
-> TcM
     ([LStmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc))], [Var])
tc_io_stmts = HsStmtContext GhcTc
-> TcStmtChecker HsExpr ExpType
-> [LStmt
      (GhcPass 'Renamed)
      (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))]
-> ExpType
-> (ExpType -> TcM [Var])
-> TcM
     ([LStmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc))], [Var])
forall (body :: * -> *) rho_type thing.
AnnoBody body =>
HsStmtContext GhcTc
-> TcStmtChecker body rho_type
-> [LStmt (GhcPass 'Renamed) (LocatedA (body (GhcPass 'Renamed)))]
-> rho_type
-> (rho_type -> TcM thing)
-> TcM ([LStmt GhcTc (LocatedA (body GhcTc))], thing)
tcStmtsAndThen (HsDoFlavour -> HsStmtContext GhcTc
forall p. HsDoFlavour -> HsStmtContext p
HsDoStmt HsDoFlavour
GhciStmtCtxt) HsStmtContext GhcTc
-> StmtLR
     (GhcPass 'Renamed)
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> ExpType
-> (ExpType -> TcM thing)
-> TcM (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)), thing)
TcStmtChecker HsExpr ExpType
tcDoStmt [GhciLStmt (GhcPass 'Renamed)]
[LStmt
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))]
stmts
                                         (Type -> ExpType
mkCheckExpType Type
io_ret_ty)
            names :: [IdP (GhcPass 'Renamed)]
names = CollectFlag (GhcPass 'Renamed)
-> [LStmt
      (GhcPass 'Renamed)
      (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))]
-> [IdP (GhcPass 'Renamed)]
forall (idL :: Pass) (idR :: Pass) body.
CollectPass (GhcPass idL) =>
CollectFlag (GhcPass idL)
-> [LStmtLR (GhcPass idL) (GhcPass idR) body]
-> [IdP (GhcPass idL)]
collectLStmtsBinders CollectFlag (GhcPass 'Renamed)
forall p. CollectFlag p
CollNoDictBinders [GhciLStmt (GhcPass 'Renamed)]
[LStmt
   (GhcPass 'Renamed)
   (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))]
stmts

        -- OK, we're ready to typecheck the stmts
      ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"GHC.Tc.Module.tcGhciStmts: tc stmts" SDoc
forall doc. IsOutput doc => doc
empty
      ; (([LocatedAn
   AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
tc_stmts, [Var]
ids), WantedConstraints
lie) <- TcM
  ([LocatedAn
      AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))],
   [Var])
-> TcM
     (([LocatedAn
          AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))],
       [Var]),
      WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureTopConstraints (TcM
   ([LocatedAn
       AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))],
    [Var])
 -> TcM
      (([LocatedAn
           AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))],
        [Var]),
       WantedConstraints))
-> TcM
     ([LocatedAn
         AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))],
      [Var])
-> TcM
     (([LocatedAn
          AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))],
       [Var]),
      WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                                  (ExpType -> TcM [Var])
-> TcM
     ([LStmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc))], [Var])
tc_io_stmts ((ExpType -> TcM [Var])
 -> TcM
      ([LStmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc))], [Var]))
-> (ExpType -> TcM [Var])
-> TcM
     ([LStmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc))], [Var])
forall a b. (a -> b) -> a -> b
$ \ ExpType
_ ->
                                  (Name -> TcM Var) -> [Name] -> TcM [Var]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> [a] -> m [b]
mapM Name -> TcM Var
tcLookupId [IdP (GhcPass 'Renamed)]
[Name]
names
                        -- Look up the names right in the middle,
                        -- where they will all be in scope

        -- Simplify the context
      ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"GHC.Tc.Module.tcGhciStmts: simplify ctxt" SDoc
forall doc. IsOutput doc => doc
empty
      ; Bag EvBind
const_binds <- TcRn (Bag EvBind) -> TcRn (Bag EvBind)
forall r. TcM r -> TcM r
checkNoErrs (WantedConstraints -> TcRn (Bag EvBind)
simplifyInteractive WantedConstraints
lie)
                -- checkNoErrs ensures that the plan fails if context redn fails


      ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"GHC.Tc.Module.tcGhciStmts: done" SDoc
forall doc. IsOutput doc => doc
empty

      -- ret_expr is the expression
      --      returnIO @[Any] [unsafeCoerce# @Any x, ..,  unsafeCoerce# @Any z]
      --
      -- Despite the inconvenience of building the type applications etc,
      -- this *has* to be done in type-annotated post-typecheck form
      -- because we are going to return a list of *polymorphic* values
      -- coerced to type Any. If we built a *source* stmt
      --      return [coerce x, ..., coerce z]
      -- then the type checker would instantiate x..z, and we wouldn't
      -- get their *polymorphic* values.  (And we'd get ambiguity errs
      -- if they were overloaded, since they aren't applied to anything.)
      --
      -- We use Any rather than a dummy type such as () because of
      -- the rules of unsafeCoerce#; see Unsafe/Coerce.hs for the details.

      ; AnId Var
unsafe_coerce_id <- Name -> TcM TyThing
tcLookupGlobal Name
unsafeCoercePrimName
           -- We use unsafeCoerce# here because of (U11) in
           -- Note [Implementing unsafeCoerce] in base:Unsafe.Coerce

      ; let ret_expr :: LHsExpr GhcTc
ret_expr = LHsExpr GhcTc -> LHsExpr GhcTc -> LHsExpr GhcTc
forall (id :: Pass).
IsPass id =>
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
nlHsApp (Var -> [Type] -> LHsExpr GhcTc
nlHsTyApp Var
ret_id [Type
ret_ty]) (LHsExpr GhcTc -> LHsExpr GhcTc) -> LHsExpr GhcTc -> LHsExpr GhcTc
forall a b. (a -> b) -> a -> b
$
                       HsExpr GhcTc -> GenLocated SrcSpanAnnA (HsExpr GhcTc)
forall a an. a -> LocatedAn an a
noLocA (HsExpr GhcTc -> GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> HsExpr GhcTc -> GenLocated SrcSpanAnnA (HsExpr GhcTc)
forall a b. (a -> b) -> a -> b
$ XExplicitList GhcTc -> [LHsExpr GhcTc] -> HsExpr GhcTc
forall p. XExplicitList p -> [LHsExpr p] -> HsExpr p
ExplicitList XExplicitList GhcTc
Type
any_lifted ([LHsExpr GhcTc] -> HsExpr GhcTc)
-> [LHsExpr GhcTc] -> HsExpr GhcTc
forall a b. (a -> b) -> a -> b
$
                       (Var -> GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> [Var] -> [GenLocated SrcSpanAnnA (HsExpr GhcTc)]
forall a b. (a -> b) -> [a] -> [b]
map Var -> LHsExpr GhcTc
Var -> GenLocated SrcSpanAnnA (HsExpr GhcTc)
mk_item [Var]
ids

            mk_item :: Var -> LHsExpr GhcTc
mk_item Var
id = Var
unsafe_coerce_id Var -> [Type] -> LHsExpr GhcTc
`nlHsTyApp` [ HasDebugCallStack => Type -> Type
Type -> Type
getRuntimeRep (Var -> Type
idType Var
id)
                                                      , HasDebugCallStack => Type -> Type
Type -> Type
getRuntimeRep Type
any_lifted
                                                      , Var -> Type
idType Var
id, Type
any_lifted]
                                          LHsExpr GhcTc -> LHsExpr GhcTc -> LHsExpr GhcTc
forall (id :: Pass).
IsPass id =>
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
`nlHsApp` IdP GhcTc -> LHsExpr GhcTc
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP GhcTc
Var
id
            stmts :: [LocatedAn
   AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
stmts = [LocatedAn
   AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
tc_stmts [LocatedAn
   AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
-> [LocatedAn
      AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
-> [LocatedAn
      AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
forall a. [a] -> [a] -> [a]
++ [Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> LocatedAn
     AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))
forall a an. a -> LocatedAn an a
noLocA (GenLocated SrcSpanAnnA (HsExpr GhcTc)
-> Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall (idR :: Pass) (bodyR :: * -> *) (idL :: Pass).
IsPass idR =>
LocatedA (bodyR (GhcPass idR))
-> StmtLR
     (GhcPass idL) (GhcPass idR) (LocatedA (bodyR (GhcPass idR)))
mkLastStmt LHsExpr GhcTc
GenLocated SrcSpanAnnA (HsExpr GhcTc)
ret_expr)]

      ; ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
-> TcM ([Var], GenLocated SrcSpanAnnA (HsExpr GhcTc))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ([Var]
ids, TcEvBinds -> LHsExpr GhcTc -> LHsExpr GhcTc
mkHsDictLet (Bag EvBind -> TcEvBinds
EvBinds Bag EvBind
const_binds) (LHsExpr GhcTc -> LHsExpr GhcTc) -> LHsExpr GhcTc -> LHsExpr GhcTc
forall a b. (a -> b) -> a -> b
$
                     HsExpr GhcTc -> GenLocated SrcSpanAnnA (HsExpr GhcTc)
forall a an. a -> LocatedAn an a
noLocA (XDo GhcTc
-> HsDoFlavour -> XRec GhcTc [ExprLStmt GhcTc] -> HsExpr GhcTc
forall p. XDo p -> HsDoFlavour -> XRec p [ExprLStmt p] -> HsExpr p
HsDo XDo GhcTc
Type
io_ret_ty HsDoFlavour
GhciStmtCtxt ([LocatedAn
   AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
-> LocatedAn
     AnnList
     [LocatedAn
        AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
forall a an. a -> LocatedAn an a
noLocA [LocatedAn
   AnnListItem (Stmt GhcTc (GenLocated SrcSpanAnnA (HsExpr GhcTc)))]
stmts)))
    }

-- | Generate a typed ghciStepIO expression (ghciStep :: Ty a -> IO a)
getGhciStepIO :: TcM (LHsExpr GhcRn)
getGhciStepIO :: TcM (LHsExpr (GhcPass 'Renamed))
getGhciStepIO = do
    Name
ghciTy <- TcRn Name
getGHCiMonad
    Name
a_tv <- OccName -> TcRn Name
newName (FastString -> OccName
mkTyVarOccFS (String -> FastString
fsLit String
"a"))
    let ghciM :: LHsType (GhcPass 'Renamed)
ghciM   = LHsType (GhcPass 'Renamed)
-> LHsType (GhcPass 'Renamed) -> LHsType (GhcPass 'Renamed)
forall (p :: Pass).
LHsType (GhcPass p) -> LHsType (GhcPass p) -> LHsType (GhcPass p)
nlHsAppTy (PromotionFlag
-> IdP (GhcPass 'Renamed) -> LHsType (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
PromotionFlag -> IdP (GhcPass p) -> LHsType (GhcPass p)
nlHsTyVar PromotionFlag
NotPromoted IdP (GhcPass 'Renamed)
Name
ghciTy) (PromotionFlag
-> IdP (GhcPass 'Renamed) -> LHsType (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
PromotionFlag -> IdP (GhcPass p) -> LHsType (GhcPass p)
nlHsTyVar PromotionFlag
NotPromoted IdP (GhcPass 'Renamed)
Name
a_tv)
        ioM :: LHsType (GhcPass 'Renamed)
ioM     = LHsType (GhcPass 'Renamed)
-> LHsType (GhcPass 'Renamed) -> LHsType (GhcPass 'Renamed)
forall (p :: Pass).
LHsType (GhcPass p) -> LHsType (GhcPass p) -> LHsType (GhcPass p)
nlHsAppTy (PromotionFlag
-> IdP (GhcPass 'Renamed) -> LHsType (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
PromotionFlag -> IdP (GhcPass p) -> LHsType (GhcPass p)
nlHsTyVar PromotionFlag
NotPromoted IdP (GhcPass 'Renamed)
Name
ioTyConName) (PromotionFlag
-> IdP (GhcPass 'Renamed) -> LHsType (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
PromotionFlag -> IdP (GhcPass p) -> LHsType (GhcPass p)
nlHsTyVar PromotionFlag
NotPromoted IdP (GhcPass 'Renamed)
Name
a_tv)

        step_ty :: LHsSigType GhcRn
        step_ty :: LHsSigType (GhcPass 'Renamed)
step_ty = HsSigType (GhcPass 'Renamed)
-> GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed))
forall a an. a -> LocatedAn an a
noLocA (HsSigType (GhcPass 'Renamed)
 -> GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed)))
-> HsSigType (GhcPass 'Renamed)
-> GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$ HsSig
                     { sig_bndrs :: HsOuterSigTyVarBndrs (GhcPass 'Renamed)
sig_bndrs = HsOuterImplicit{hso_ximplicit :: XHsOuterImplicit (GhcPass 'Renamed)
hso_ximplicit = [Name
a_tv]}
                     , sig_ext :: XHsSig (GhcPass 'Renamed)
sig_ext = XHsSig (GhcPass 'Renamed)
NoExtField
noExtField
                     , sig_body :: LHsType (GhcPass 'Renamed)
sig_body = LHsType (GhcPass 'Renamed)
-> LHsType (GhcPass 'Renamed) -> LHsType (GhcPass 'Renamed)
forall (p :: Pass).
LHsType (GhcPass p) -> LHsType (GhcPass p) -> LHsType (GhcPass p)
nlHsFunTy LHsType (GhcPass 'Renamed)
ghciM LHsType (GhcPass 'Renamed)
ioM }

        stepTy :: LHsSigWcType GhcRn
        stepTy :: LHsSigWcType (GhcPass 'Renamed)
stepTy = GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed))
-> HsWildCardBndrs
     (GhcPass 'Renamed)
     (GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed)))
forall thing. thing -> HsWildCardBndrs (GhcPass 'Renamed) thing
mkEmptyWildCardBndrs LHsSigType (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed))
step_ty

    GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (HsExpr (GhcPass 'Renamed)
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
forall a an. a -> LocatedAn an a
noLocA (HsExpr (GhcPass 'Renamed)
 -> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed)))
-> HsExpr (GhcPass 'Renamed)
-> GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
forall a b. (a -> b) -> a -> b
$ XExprWithTySig (GhcPass 'Renamed)
-> LHsExpr (GhcPass 'Renamed)
-> LHsSigWcType (NoGhcTc (GhcPass 'Renamed))
-> HsExpr (GhcPass 'Renamed)
forall p.
XExprWithTySig p
-> LHsExpr p -> LHsSigWcType (NoGhcTc p) -> HsExpr p
ExprWithTySig XExprWithTySig (GhcPass 'Renamed)
NoExtField
noExtField (IdP (GhcPass 'Renamed) -> LHsExpr (GhcPass 'Renamed)
forall (p :: Pass) a.
IsSrcSpanAnn p a =>
IdP (GhcPass p) -> LHsExpr (GhcPass p)
nlHsVar IdP (GhcPass 'Renamed)
Name
ghciStepIoMName) LHsSigWcType (NoGhcTc (GhcPass 'Renamed))
LHsSigWcType (GhcPass 'Renamed)
stepTy)

isGHCiMonad :: HscEnv -> String -> IO (Messages TcRnMessage, Maybe Name)
isGHCiMonad :: HscEnv -> String -> IO (Messages TcRnMessage, Maybe Name)
isGHCiMonad HscEnv
hsc_env String
ty
  = HscEnv -> TcRn Name -> IO (Messages TcRnMessage, Maybe Name)
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcRn Name -> IO (Messages TcRnMessage, Maybe Name))
-> TcRn Name -> IO (Messages TcRnMessage, Maybe Name)
forall a b. (a -> b) -> a -> b
$ do
        GlobalRdrEnv
rdrEnv <- TcRn GlobalRdrEnv
getGlobalRdrEnv
        let occIO :: Maybe [GlobalRdrElt]
occIO = GlobalRdrEnv -> OccName -> Maybe [GlobalRdrElt]
forall a. OccEnv a -> OccName -> Maybe a
lookupOccEnv GlobalRdrEnv
rdrEnv (NameSpace -> String -> OccName
mkOccName NameSpace
tcName String
ty)
        case Maybe [GlobalRdrElt]
occIO of
            Just [GlobalRdrElt
n] -> do
                let name :: Name
name = GlobalRdrElt -> Name
forall info. GlobalRdrEltX info -> Name
greName GlobalRdrElt
n
                Class
ghciClass <- Name -> TcM Class
tcLookupClass Name
ghciIoClassName
                TyCon
userTyCon <- Name -> TcM TyCon
tcLookupTyCon Name
name
                let userTy :: Type
userTy = TyCon -> [Type] -> Type
mkTyConApp TyCon
userTyCon []
                ClsInst
_ <- Class -> [Type] -> TcM ClsInst
tcLookupInstance Class
ghciClass [Type
userTy]
                Name -> TcRn Name
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Name
name
            Maybe [GlobalRdrElt]
_ -> TcRnMessage -> TcRn Name
forall a. TcRnMessage -> TcM a
failWithTc (TcRnMessage -> TcRn Name) -> TcRnMessage -> TcRn Name
forall a b. (a -> b) -> a -> b
$ String -> Maybe [GlobalRdrElt] -> TcRnMessage
TcRnGhciMonadLookupFail String
ty Maybe [GlobalRdrElt]
occIO

-- | How should we infer a type? See Note [TcRnExprMode]
data TcRnExprMode = TM_Inst     -- ^ Instantiate inferred quantifiers only (:type)
                  | TM_Default  -- ^ Instantiate all quantifiers,
                                --   and do eager defaulting (:type +d)

-- | tcRnExpr just finds the type of an expression
--   for :type
tcRnExpr :: HscEnv
         -> TcRnExprMode
         -> LHsExpr GhcPs
         -> IO (Messages TcRnMessage, Maybe Type)
tcRnExpr :: HscEnv
-> TcRnExprMode
-> LHsExpr GhcPs
-> IO (Messages TcRnMessage, Maybe Type)
tcRnExpr HscEnv
hsc_env TcRnExprMode
mode LHsExpr GhcPs
rdr_expr
  = HscEnv -> TcM Type -> IO (Messages TcRnMessage, Maybe Type)
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcM Type -> IO (Messages TcRnMessage, Maybe Type))
-> TcM Type -> IO (Messages TcRnMessage, Maybe Type)
forall a b. (a -> b) -> a -> b
$
    do {

    (GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr, FreeVars
_fvs) <- LHsExpr GhcPs -> RnM (LHsExpr (GhcPass 'Renamed), FreeVars)
rnLExpr LHsExpr GhcPs
rdr_expr ;
    IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM ;

    -- Typecheck the expression
    ((TcLevel
tclvl, Type
res_ty), WantedConstraints
lie)
          <- TcM (TcLevel, Type) -> TcM ((TcLevel, Type), WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureTopConstraints (TcM (TcLevel, Type) -> TcM ((TcLevel, Type), WantedConstraints))
-> TcM (TcLevel, Type) -> TcM ((TcLevel, Type), WantedConstraints)
forall a b. (a -> b) -> a -> b
$
             TcM Type -> TcM (TcLevel, Type)
forall a. TcM a -> TcM (TcLevel, a)
pushTcLevelM          (TcM Type -> TcM (TcLevel, Type))
-> TcM Type -> TcM (TcLevel, Type)
forall a b. (a -> b) -> a -> b
$
             Bool -> LHsExpr (GhcPass 'Renamed) -> TcM Type
tcInferSigma Bool
inst LHsExpr (GhcPass 'Renamed)
GenLocated SrcSpanAnnA (HsExpr (GhcPass 'Renamed))
rn_expr ;

    -- Generalise
    Unique
uniq <- TcRnIf TcGblEnv TcLclEnv Unique
forall gbl lcl. TcRnIf gbl lcl Unique
newUnique ;
    let { fresh_it :: Name
fresh_it = Unique -> SrcSpan -> Name
itName Unique
uniq (GenLocated SrcSpanAnnA (HsExpr GhcPs) -> SrcSpan
forall a e. GenLocated (SrcSpanAnn' a) e -> SrcSpan
getLocA LHsExpr GhcPs
GenLocated SrcSpanAnnA (HsExpr GhcPs)
rdr_expr) } ;
    (([Var]
qtvs, [Var]
dicts, TcEvBinds
_, Bool
_), WantedConstraints
residual)
         <- TcM ([Var], [Var], TcEvBinds, Bool)
-> TcM (([Var], [Var], TcEvBinds, Bool), WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureConstraints (TcM ([Var], [Var], TcEvBinds, Bool)
 -> TcM (([Var], [Var], TcEvBinds, Bool), WantedConstraints))
-> TcM ([Var], [Var], TcEvBinds, Bool)
-> TcM (([Var], [Var], TcEvBinds, Bool), WantedConstraints)
forall a b. (a -> b) -> a -> b
$
            TcLevel
-> InferMode
-> [TcIdSigInst]
-> [(Name, Type)]
-> WantedConstraints
-> TcM ([Var], [Var], TcEvBinds, Bool)
simplifyInfer TcLevel
tclvl InferMode
infer_mode
                          []    {- No sig vars -}
                          [(Name
fresh_it, Type
res_ty)]
                          WantedConstraints
lie ;

    -- Ignore the dictionary bindings
    Bag EvBind
_ <- TcRn (Bag EvBind) -> TcRn (Bag EvBind)
perhaps_disable_default_warnings (TcRn (Bag EvBind) -> TcRn (Bag EvBind))
-> TcRn (Bag EvBind) -> TcRn (Bag EvBind)
forall a b. (a -> b) -> a -> b
$
         WantedConstraints -> TcRn (Bag EvBind)
simplifyInteractive WantedConstraints
residual ;

    let { all_expr_ty :: Type
all_expr_ty = [Var] -> Type -> Type
mkInfForAllTys [Var]
qtvs (Type -> Type) -> Type -> Type
forall a b. (a -> b) -> a -> b
$
                        [Type] -> Type -> Type
HasDebugCallStack => [Type] -> Type -> Type
mkPhiTy ((Var -> Type) -> [Var] -> [Type]
forall a b. (a -> b) -> [a] -> [b]
map Var -> Type
idType [Var]
dicts) Type
res_ty } ;
    Type
ty <- ZonkM Type -> TcM Type
forall a. ZonkM a -> TcM a
liftZonkM (ZonkM Type -> TcM Type) -> ZonkM Type -> TcM Type
forall a b. (a -> b) -> a -> b
$ Type -> ZonkM Type
zonkTcType Type
all_expr_ty ;

    -- See Note [Normalising the type in :type]
    FamInstEnvs
fam_envs <- TcM FamInstEnvs
tcGetFamInstEnvs ;
    let { normalised_type :: Type
normalised_type = Reduction -> Type
reductionReducedType (Reduction -> Type) -> Reduction -> Type
forall a b. (a -> b) -> a -> b
$ FamInstEnvs -> Role -> Type -> Reduction
normaliseType FamInstEnvs
fam_envs Role
Nominal Type
ty
          -- normaliseType returns a coercion which we discard, so the Role is irrelevant.
        ; final_type :: Type
final_type = if Type -> Bool
isSigmaTy Type
res_ty then Type
ty else Type
normalised_type } ;
    Type -> TcM Type
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return Type
final_type }
  where
    -- Optionally instantiate the type of the expression
    -- See Note [TcRnExprMode]
    (Bool
inst, InferMode
infer_mode, TcRn (Bag EvBind) -> TcRn (Bag EvBind)
perhaps_disable_default_warnings) = case TcRnExprMode
mode of
      TcRnExprMode
TM_Inst    -> (Bool
False, InferMode
NoRestrictions,  TcRn (Bag EvBind) -> TcRn (Bag EvBind)
forall a. a -> a
id)
      TcRnExprMode
TM_Default -> (Bool
True,  InferMode
EagerDefaulting, WarningFlag -> TcRn (Bag EvBind) -> TcRn (Bag EvBind)
forall gbl lcl a.
WarningFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
unsetWOptM WarningFlag
Opt_WarnTypeDefaults)

{- Note [Implementing :type]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider   :type const

We want    forall a b. a -> b -> a
and not    forall {a}{b}. a -> b -> a

The latter is what we'd get if we eagerly instantiated and then
re-generalised with Inferred binders.  It makes a difference, because
it tells us we where we can use Visible Type Application (VTA).

And also for   :type const @Int
we want        forall b. Int -> b -> Int
and not        forall {b}. Int -> b -> Int

Solution: use tcInferSigma, which in turn uses tcInferApp, which
has a special case for application chains.

Note [Normalising the type in :type]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In :t <expr> we usually normalise the type (to simplify type functions)
before displaying the result.  Reason (see #10321): otherwise we may show
types like
    <expr> :: Vec (1+2) Int
rather than the simpler
    <expr> :: Vec 3 Int
In GHC.Tc.Gen.Bind.mkInferredPolyId we normalise for a very similar reason.

However this normalisation is less helpful when <expr> is just
an identifier, whose user-written type happens to contain type-function
applications.  E.g. (#20974)
    test :: F [Monad, A, B] m => m ()
where F is a type family.  If we say `:t test`, we'd prefer to see
the type family un-expanded.

We adopt the following ad-hoc solution: if the type inferred for <expr>
(before generalisation, namely res_ty) is a SigmaType (i.e. is not
fully instantiated) then do not normalise; otherwise normalise.
This is not ideal; for example, suppose  x :: F Int.  Then
  :t x
would be normalised because `F Int` is not a SigmaType.  But
anything here is ad-hoc, and it's a user-sought improvement.
-}

--------------------------
tcRnImportDecls :: HscEnv
                -> [LImportDecl GhcPs]
                -> IO (Messages TcRnMessage, Maybe GlobalRdrEnv)
-- Find the new chunk of GlobalRdrEnv created by this list of import
-- decls.  In contract tcRnImports *extends* the TcGblEnv.
tcRnImportDecls :: HscEnv
-> [LImportDecl GhcPs]
-> IO (Messages TcRnMessage, Maybe GlobalRdrEnv)
tcRnImportDecls HscEnv
hsc_env [LImportDecl GhcPs]
import_decls
 =  HscEnv
-> TcRn GlobalRdrEnv
-> IO (Messages TcRnMessage, Maybe GlobalRdrEnv)
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcRn GlobalRdrEnv
 -> IO (Messages TcRnMessage, Maybe GlobalRdrEnv))
-> TcRn GlobalRdrEnv
-> IO (Messages TcRnMessage, Maybe GlobalRdrEnv)
forall a b. (a -> b) -> a -> b
$
    do { TcGblEnv
gbl_env <- (TcGblEnv -> TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall gbl lcl a.
(gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
updGblEnv TcGblEnv -> TcGblEnv
zap_rdr_env (TcM TcGblEnv -> TcM TcGblEnv) -> TcM TcGblEnv -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$
                    HscEnv -> [(LImportDecl GhcPs, SDoc)] -> TcM TcGblEnv
tcRnImports HscEnv
hsc_env ([(LImportDecl GhcPs, SDoc)] -> TcM TcGblEnv)
-> [(LImportDecl GhcPs, SDoc)] -> TcM TcGblEnv
forall a b. (a -> b) -> a -> b
$ (GenLocated SrcSpanAnnA (ImportDecl GhcPs)
 -> (GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc))
-> [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
-> [(GenLocated SrcSpanAnnA (ImportDecl GhcPs), SDoc)]
forall a b. (a -> b) -> [a] -> [b]
map (,String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"is directly imported") [LImportDecl GhcPs]
[GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
import_decls
       ; GlobalRdrEnv -> TcRn GlobalRdrEnv
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcGblEnv -> GlobalRdrEnv
tcg_rdr_env TcGblEnv
gbl_env) }
  where
    zap_rdr_env :: TcGblEnv -> TcGblEnv
zap_rdr_env TcGblEnv
gbl_env = TcGblEnv
gbl_env { tcg_rdr_env = emptyGlobalRdrEnv }

-- tcRnType just finds the kind of a type
tcRnType :: HscEnv
         -> ZonkFlexi
         -> Bool        -- Normalise the returned type
         -> LHsType GhcPs
         -> IO (Messages TcRnMessage, Maybe (Type, Kind))
tcRnType :: HscEnv
-> ZonkFlexi
-> Bool
-> LHsType GhcPs
-> IO (Messages TcRnMessage, Maybe (Type, Type))
tcRnType HscEnv
hsc_env ZonkFlexi
flexi Bool
normalise LHsType GhcPs
rdr_type
  = HscEnv
-> TcM (Type, Type)
-> IO (Messages TcRnMessage, Maybe (Type, Type))
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcM (Type, Type) -> IO (Messages TcRnMessage, Maybe (Type, Type)))
-> TcM (Type, Type)
-> IO (Messages TcRnMessage, Maybe (Type, Type))
forall a b. (a -> b) -> a -> b
$
    Extension -> TcM (Type, Type) -> TcM (Type, Type)
forall gbl lcl a. Extension -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
setXOptM Extension
LangExt.PolyKinds (TcM (Type, Type) -> TcM (Type, Type))
-> TcM (Type, Type) -> TcM (Type, Type)
forall a b. (a -> b) -> a -> b
$   -- See Note [Kind-generalise in tcRnType]
    do { (HsWC { hswc_ext :: forall pass thing. HsWildCardBndrs pass thing -> XHsWC pass thing
hswc_ext = XHsWC
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed)))
wcs, hswc_body :: forall pass thing. HsWildCardBndrs pass thing -> thing
hswc_body = rn_sig_type :: GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed))
rn_sig_type@(L SrcSpanAnnA
_ (HsSig{sig_bndrs :: forall pass. HsSigType pass -> HsOuterSigTyVarBndrs pass
sig_bndrs = HsOuterSigTyVarBndrs (GhcPass 'Renamed)
outer_bndrs, sig_body :: forall pass. HsSigType pass -> LHsType pass
sig_body = LHsType (GhcPass 'Renamed)
body })) }, FreeVars
_fvs)
                 -- we are using 'rnHsSigWcType' to bind the unbound type variables
                 -- and in combination with 'tcOuterTKBndrs' we are able to
                 -- implicitly quantify them as if the user wrote 'forall' by
                 -- hand (see #19217). This allows kind check to work in presence
                 -- of free type variables :
                 -- ghci> :k [a]
                 -- [a] :: *
               <- HsDocContext
-> LHsSigWcType GhcPs
-> RnM (LHsSigWcType (GhcPass 'Renamed), FreeVars)
rnHsSigWcType HsDocContext
GHCiCtx (LHsSigType GhcPs -> LHsSigWcType GhcPs
forall thing. thing -> HsWildCardBndrs GhcPs thing
mkHsWildCardBndrs (LHsSigType GhcPs -> LHsSigWcType GhcPs)
-> LHsSigType GhcPs -> LHsSigWcType GhcPs
forall a b. (a -> b) -> a -> b
$ HsSigType GhcPs -> LocatedAn AnnListItem (HsSigType GhcPs)
forall a an. a -> LocatedAn an a
noLocA (LHsType GhcPs -> HsSigType GhcPs
mkHsImplicitSigType LHsType GhcPs
rdr_type))
                  -- The type can have wild cards, but no implicit
                  -- generalisation; e.g.   :kind (T _)
       ; IOEnv (Env TcGblEnv TcLclEnv) ()
failIfErrsM

        -- We follow Note [Recipe for checking a signature] in GHC.Tc.Gen.HsType here

        -- Now kind-check the type
        -- It can have any rank or kind
        -- First bring into scope any wildcards
       ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"tcRnType" ([SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat [[Name] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [Name]
XHsWC
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed)))
wcs, GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed))
rn_sig_type])
       ; SkolemInfo
si <- SkolemInfoAnon -> IOEnv (Env TcGblEnv TcLclEnv) SkolemInfo
forall (m :: * -> *). MonadIO m => SkolemInfoAnon -> m SkolemInfo
mkSkolemInfo (SkolemInfoAnon -> IOEnv (Env TcGblEnv TcLclEnv) SkolemInfo)
-> SkolemInfoAnon -> IOEnv (Env TcGblEnv TcLclEnv) SkolemInfo
forall a b. (a -> b) -> a -> b
$ UserTypeCtxt -> SkolemInfoAnon
SigTypeSkol (Bool -> UserTypeCtxt
GhciCtxt Bool
True)
       ; ((HsOuterTyVarBndrs Specificity GhcTc
_, (Type
ty, Type
kind)), WantedConstraints
wanted)
               <- TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
-> TcM
     ((HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)),
      WantedConstraints)
forall a. TcM a -> TcM (a, WantedConstraints)
captureTopConstraints (TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
 -> TcM
      ((HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)),
       WantedConstraints))
-> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
-> TcM
     ((HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)),
      WantedConstraints)
forall a b. (a -> b) -> a -> b
$
                  TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
-> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
forall r. TcM r -> TcM r
pushTcLevelM_         (TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
 -> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)))
-> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
-> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
forall a b. (a -> b) -> a -> b
$
                  [Name]
-> ([(Name, Var)]
    -> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)))
-> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
forall a. [Name] -> ([(Name, Var)] -> TcM a) -> TcM a
bindNamedWildCardBinders [Name]
XHsWC
  (GhcPass 'Renamed)
  (GenLocated SrcSpanAnnA (HsSigType (GhcPass 'Renamed)))
wcs (([(Name, Var)]
  -> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)))
 -> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)))
-> ([(Name, Var)]
    -> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)))
-> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
forall a b. (a -> b) -> a -> b
$ \ [(Name, Var)]
wcs' ->
                  do { ((Name, Var) -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> [(Name, Var)] -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ (Name, Var) -> IOEnv (Env TcGblEnv TcLclEnv) ()
emitNamedTypeHole [(Name, Var)]
wcs'
                     ; SkolemInfo
-> HsOuterSigTyVarBndrs (GhcPass 'Renamed)
-> TcM (Type, Type)
-> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
forall flag a.
OutputableBndrFlag flag 'Renamed =>
SkolemInfo
-> HsOuterTyVarBndrs flag (GhcPass 'Renamed)
-> TcM a
-> TcM (HsOuterTyVarBndrs flag GhcTc, a)
tcOuterTKBndrs SkolemInfo
si HsOuterSigTyVarBndrs (GhcPass 'Renamed)
outer_bndrs (TcM (Type, Type)
 -> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type)))
-> TcM (Type, Type)
-> TcM (HsOuterTyVarBndrs Specificity GhcTc, (Type, Type))
forall a b. (a -> b) -> a -> b
$ LHsType (GhcPass 'Renamed) -> TcM (Type, Type)
tcInferLHsTypeUnsaturated LHsType (GhcPass 'Renamed)
body }
       -- Since all the wanteds are equalities, the returned bindings will be empty
       ; Bag EvBind
empty_binds <- WantedConstraints -> TcRn (Bag EvBind)
simplifyTop WantedConstraints
wanted
       ; Bool -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (m :: * -> *).
(HasCallStack, Applicative m) =>
Bool -> SDoc -> m ()
massertPpr (Bag EvBind -> Bool
forall a. Bag a -> Bool
isEmptyBag Bag EvBind
empty_binds) (Bag EvBind -> SDoc
forall a. Outputable a => a -> SDoc
ppr Bag EvBind
empty_binds)

       -- Do kind generalisation; see Note [Kind-generalise in tcRnType]
       ; [Var]
kvs <- SkolemInfo -> Type -> TcM [Var]
kindGeneralizeAll SkolemInfo
HasDebugCallStack => SkolemInfo
unkSkol Type
kind

       ; Type
ty  <- ZonkFlexi -> ZonkT (IOEnv (Env TcGblEnv TcLclEnv)) Type -> TcM Type
forall (m :: * -> *) b. MonadIO m => ZonkFlexi -> ZonkT m b -> m b
initZonkEnv ZonkFlexi
flexi (ZonkT (IOEnv (Env TcGblEnv TcLclEnv)) Type -> TcM Type)
-> ZonkT (IOEnv (Env TcGblEnv TcLclEnv)) Type -> TcM Type
forall a b. (a -> b) -> a -> b
$ Type -> ZonkT (IOEnv (Env TcGblEnv TcLclEnv)) Type
zonkTcTypeToTypeX Type
ty

       -- Do validity checking on type
       ; UserTypeCtxt -> Type -> IOEnv (Env TcGblEnv TcLclEnv) ()
checkValidType (Bool -> UserTypeCtxt
GhciCtxt Bool
True) Type
ty

       -- Optionally (:k vs :k!) normalise the type. Does two things:
       --   normaliseType: expand type-family applications
       --   expandTypeSynonyms: expand type synonyms (#18828)
       ; FamInstEnvs
fam_envs <- TcM FamInstEnvs
tcGetFamInstEnvs
       ; let ty' :: Type
ty' | Bool
normalise = Type -> Type
expandTypeSynonyms (Type -> Type) -> Type -> Type
forall a b. (a -> b) -> a -> b
$ Reduction -> Type
reductionReducedType (Reduction -> Type) -> Reduction -> Type
forall a b. (a -> b) -> a -> b
$
                               FamInstEnvs -> Role -> Type -> Reduction
normaliseType FamInstEnvs
fam_envs Role
Nominal Type
ty
                 | Bool
otherwise = Type
ty

       ; String -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
traceTc String
"tcRnExpr" (Type -> SDoc
debugPprType Type
ty SDoc -> SDoc -> SDoc
forall doc. IsDoc doc => doc -> doc -> doc
$$ Type -> SDoc
debugPprType Type
ty')
       ; (Type, Type) -> TcM (Type, Type)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (Type
ty', [Var] -> Type -> Type
mkInfForAllTys [Var]
kvs (HasDebugCallStack => Type -> Type
Type -> Type
typeKind Type
ty')) }


{- Note [TcRnExprMode]
~~~~~~~~~~~~~~~~~~~~~~
How should we infer a type when a user asks for the type of an expression e
at the GHCi prompt? We offer 2 different possibilities, described below. Each
considers this example, with -fprint-explicit-foralls enabled.  See also
https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0179-printing-foralls.rst

:type / TM_Inst

  In this mode, we report the type obtained by instantiating only the
  /inferred/ quantifiers of e's type, solving constraints, and
  re-generalising, as discussed in #11376.

  > :type reverse
  reverse :: forall a. [a] -> [a]

  -- foo :: forall a f b. (Show a, Num b, Foldable f) => a -> f b -> String
  > :type foo @Int
  forall f b. (Show Int, Num b, Foldable f) => Int -> f b -> String

  Note that Show Int is still reported, because the solver never got a chance
  to see it.

:type +d / TM_Default

  This mode is for the benefit of users who wish to see instantiations
  of generalized types, and in particular to instantiate Foldable and
  Traversable.  In this mode, all type variables (inferred or
  specified) are instantiated.  Because GHCi uses
  -XExtendedDefaultRules, this means that Foldable and Traversable are
  defaulted.

  > :type +d reverse
  reverse :: forall {a}. [a] -> [a]

  -- foo :: forall a f b. (Show a, Num b, Foldable f) => a -> f b -> String
  > :type +d foo @Int
  Int -> [Integer] -> String

  Note that this mode can sometimes lead to a type error, if a type variable is
  used with a defaultable class but cannot actually be defaulted:

  bar :: (Num a, Monoid a) => a -> a
  > :type +d bar
  ** error **

  The error arises because GHC tries to default a but cannot find a concrete
  type in the defaulting list that is both Num and Monoid. (If this list is
  modified to include an element that is both Num and Monoid, the defaulting
  would succeed, of course.)

  Note that the variables and constraints are reordered here, because this
  is possible during regeneralization. Also note that the variables are
  reported as Inferred instead of Specified.

Note [Kind-generalise in tcRnType]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We switch on PolyKinds when kind-checking a user type, so that we will
kind-generalise the type, even when PolyKinds is not otherwise on.
This gives the right default behaviour at the GHCi prompt, where if
you say ":k T", and T has a polymorphic kind, you'd like to see that
polymorphism. Of course.  If T isn't kind-polymorphic you won't get
anything unexpected, but the apparent *loss* of polymorphism, for
types that you know are polymorphic, is quite surprising.  See Trac
#7688 for a discussion.

Note that the goal is to generalise the *kind of the type*, not
the type itself! Example:
  ghci> data SameKind :: k -> k -> Type
  ghci> :k SameKind _

We want to get `k -> Type`, not `Any -> Type`, which is what we would
get without kind-generalisation. Note that `:k SameKind` is OK, as
GHC will not instantiate SameKind here, and so we see its full kind
of `forall k. k -> k -> Type`.

************************************************************************
*                                                                      *
                 tcRnDeclsi
*                                                                      *
************************************************************************

tcRnDeclsi exists to allow class, data, and other declarations in GHCi.
-}

tcRnDeclsi :: HscEnv
           -> [LHsDecl GhcPs]
           -> IO (Messages TcRnMessage, Maybe TcGblEnv)
tcRnDeclsi :: HscEnv
-> [LHsDecl GhcPs] -> IO (Messages TcRnMessage, Maybe TcGblEnv)
tcRnDeclsi HscEnv
hsc_env [LHsDecl GhcPs]
local_decls
  = HscEnv -> TcM TcGblEnv -> IO (Messages TcRnMessage, Maybe TcGblEnv)
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcM TcGblEnv -> IO (Messages TcRnMessage, Maybe TcGblEnv))
-> TcM TcGblEnv -> IO (Messages TcRnMessage, Maybe TcGblEnv)
forall a b. (a -> b) -> a -> b
$
    Bool
-> Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
-> [LHsDecl GhcPs]
-> TcM TcGblEnv
tcRnSrcDecls Bool
False Maybe (LocatedAn AnnList [XRec GhcPs (IE GhcPs)])
Maybe (GenLocated SrcSpanAnnL [GenLocated SrcSpanAnnA (IE GhcPs)])
forall a. Maybe a
Nothing [LHsDecl GhcPs]
local_decls

externaliseAndTidyId :: Module -> Id -> TcM Id
externaliseAndTidyId :: Module -> Var -> TcM Var
externaliseAndTidyId Module
this_mod Var
id
  = do { Name
name' <- Module -> Name -> TcRn Name
forall m n. Module -> Name -> TcRnIf m n Name
externaliseName Module
this_mod (Var -> Name
idName Var
id)
       ; Var -> TcM Var
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (Var -> TcM Var) -> Var -> TcM Var
forall a b. (a -> b) -> a -> b
$ Var -> Var
globaliseId Var
id
                     Var -> Name -> Var
`setIdName` Name
name'
                     Var -> Type -> Var
`setIdType` Type -> Type
tidyTopType (Var -> Type
idType Var
id) }


{-
************************************************************************
*                                                                      *
        More GHCi stuff, to do with browsing and getting info
*                                                                      *
************************************************************************
-}

-- | ASSUMES that the module is either in the 'HomePackageTable' or is
-- a package module with an interface on disk.  If neither of these is
-- true, then the result will be an error indicating the interface
-- could not be found.
getModuleInterface :: HscEnv -> Module -> IO (Messages TcRnMessage, Maybe ModIface)
getModuleInterface :: HscEnv
-> Module
-> IO (Messages TcRnMessage, Maybe (ModIface_ 'ModIfaceFinal))
getModuleInterface HscEnv
hsc_env Module
mod
  = HscEnv
-> IOEnv (Env TcGblEnv TcLclEnv) (ModIface_ 'ModIfaceFinal)
-> IO (Messages TcRnMessage, Maybe (ModIface_ 'ModIfaceFinal))
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (IOEnv (Env TcGblEnv TcLclEnv) (ModIface_ 'ModIfaceFinal)
 -> IO (Messages TcRnMessage, Maybe (ModIface_ 'ModIfaceFinal)))
-> IOEnv (Env TcGblEnv TcLclEnv) (ModIface_ 'ModIfaceFinal)
-> IO (Messages TcRnMessage, Maybe (ModIface_ 'ModIfaceFinal))
forall a b. (a -> b) -> a -> b
$
    SDoc
-> Module
-> IOEnv (Env TcGblEnv TcLclEnv) (ModIface_ 'ModIfaceFinal)
loadModuleInterface (String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"getModuleInterface") Module
mod

tcRnLookupRdrName :: HscEnv -> LocatedN RdrName
                  -> IO (Messages TcRnMessage, Maybe [Name])
-- ^ Find all the Names that this RdrName could mean, in GHCi
tcRnLookupRdrName :: HscEnv
-> GenLocated SrcSpanAnnN RdrName
-> IO (Messages TcRnMessage, Maybe [Name])
tcRnLookupRdrName HscEnv
hsc_env (L SrcSpanAnnN
loc RdrName
rdr_name)
  = HscEnv -> TcRn [Name] -> IO (Messages TcRnMessage, Maybe [Name])
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcRn [Name] -> IO (Messages TcRnMessage, Maybe [Name]))
-> TcRn [Name] -> IO (Messages TcRnMessage, Maybe [Name])
forall a b. (a -> b) -> a -> b
$
    SrcSpanAnnN -> TcRn [Name] -> TcRn [Name]
forall ann a. SrcSpanAnn' ann -> TcRn a -> TcRn a
setSrcSpanA SrcSpanAnnN
loc          (TcRn [Name] -> TcRn [Name]) -> TcRn [Name] -> TcRn [Name]
forall a b. (a -> b) -> a -> b
$
    do {   -- If the identifier is a constructor (begins with an
           -- upper-case letter), then we need to consider both
           -- constructor and type class identifiers.
         let rdr_names :: [RdrName]
rdr_names = RdrName -> [RdrName]
dataTcOccs RdrName
rdr_name
       ; [[Name]]
names_s <- (RdrName -> TcRn [Name])
-> [RdrName] -> IOEnv (Env TcGblEnv TcLclEnv) [[Name]]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> [a] -> m [b]
mapM RdrName -> TcRn [Name]
lookupInfoOccRn [RdrName]
rdr_names
       ; let names :: [Name]
names = [[Name]] -> [Name]
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [[Name]]
names_s
       ; Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when ([Name] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [Name]
names) (TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
addErrTc (TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$ RdrName -> NotInScopeError -> TcRnMessage
mkTcRnNotInScope RdrName
rdr_name NotInScopeError
NotInScope)
       ; [Name] -> TcRn [Name]
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return [Name]
names }

tcRnLookupName :: HscEnv -> Name -> IO (Messages TcRnMessage, Maybe TyThing)
tcRnLookupName :: HscEnv -> Name -> IO (Messages TcRnMessage, Maybe TyThing)
tcRnLookupName HscEnv
hsc_env Name
name
  = HscEnv -> TcM TyThing -> IO (Messages TcRnMessage, Maybe TyThing)
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcM TyThing -> IO (Messages TcRnMessage, Maybe TyThing))
-> TcM TyThing -> IO (Messages TcRnMessage, Maybe TyThing)
forall a b. (a -> b) -> a -> b
$
    Name -> TcM TyThing
tcRnLookupName' Name
name

-- To look up a name we have to look in the local environment (tcl_lcl)
-- as well as the global environment, which is what tcLookup does.
-- But we also want a TyThing, so we have to convert:

tcRnLookupName' :: Name -> TcRn TyThing
tcRnLookupName' :: Name -> TcM TyThing
tcRnLookupName' Name
name = do
   TcTyThing
tcthing <- Name -> TcM TcTyThing
tcLookup Name
name
   case TcTyThing
tcthing of
     AGlobal TyThing
thing    -> TyThing -> TcM TyThing
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return TyThing
thing
     ATcId{tct_id :: TcTyThing -> Var
tct_id=Var
id} -> TyThing -> TcM TyThing
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (Var -> TyThing
AnId Var
id)
     TcTyThing
_ -> String -> TcM TyThing
forall a. HasCallStack => String -> a
panic String
"tcRnLookupName'"

tcRnGetInfo :: HscEnv
            -> Name
            -> IO ( Messages TcRnMessage
                  , Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))

-- Used to implement :info in GHCi
--
-- Look up a RdrName and return all the TyThings it might be
-- A capitalised RdrName is given to us in the DataName namespace,
-- but we want to treat it as *both* a data constructor
--  *and* as a type or class constructor;
-- hence the call to dataTcOccs, and we return up to two results
tcRnGetInfo :: HscEnv
-> Name
-> IO
     (Messages TcRnMessage,
      Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))
tcRnGetInfo HscEnv
hsc_env Name
name
  = HscEnv
-> TcRn (TyThing, Fixity, [ClsInst], [FamInst], SDoc)
-> IO
     (Messages TcRnMessage,
      Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))
forall a. HscEnv -> TcRn a -> IO (Messages TcRnMessage, Maybe a)
runTcInteractive HscEnv
hsc_env (TcRn (TyThing, Fixity, [ClsInst], [FamInst], SDoc)
 -> IO
      (Messages TcRnMessage,
       Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc)))
-> TcRn (TyThing, Fixity, [ClsInst], [FamInst], SDoc)
-> IO
     (Messages TcRnMessage,
      Maybe (TyThing, Fixity, [ClsInst], [FamInst], SDoc))
forall a b. (a -> b) -> a -> b
$
    do { HscEnv -> InteractiveContext -> IOEnv (Env TcGblEnv TcLclEnv) ()
loadUnqualIfaces HscEnv
hsc_env (HscEnv -> InteractiveContext
hsc_IC HscEnv
hsc_env)
           -- Load the interface for all unqualified types and classes
           -- That way we will find all the instance declarations
           -- (Packages have not orphan modules, and we assume that
           --  in the home package all relevant modules are loaded.)

       ; TyThing
thing  <- Name -> TcM TyThing
tcRnLookupName' Name
name
       ; Fixity
fixity <- Name -> RnM Fixity
lookupFixityRn Name
name
       ; ([ClsInst]
cls_insts, [FamInst]
fam_insts) <- TyThing -> TcM ([ClsInst], [FamInst])
lookupInsts TyThing
thing
       ; let info :: SDoc
info = Name -> SDoc
lookupKnownNameInfo Name
name
       ; (TyThing, Fixity, [ClsInst], [FamInst], SDoc)
-> TcRn (TyThing, Fixity, [ClsInst], [FamInst], SDoc)
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TyThing
thing, Fixity
fixity, [ClsInst]
cls_insts, [FamInst]
fam_insts, SDoc
info) }


-- Lookup all class and family instances for a type constructor.
--
-- This function filters all instances in the type environment, so there
-- is a lot of duplicated work if it is called many times in the same
-- type environment. If this becomes a problem, the NameEnv computed
-- in GHC.getNameToInstancesIndex could be cached in TcM and both functions
-- could be changed to consult that index.
lookupInsts :: TyThing -> TcM ([ClsInst],[FamInst])
lookupInsts :: TyThing -> TcM ([ClsInst], [FamInst])
lookupInsts (ATyCon TyCon
tc)
  = do  { InstEnvs { ie_global :: InstEnvs -> InstEnv
ie_global = InstEnv
pkg_ie, ie_local :: InstEnvs -> InstEnv
ie_local = InstEnv
home_ie, ie_visible :: InstEnvs -> VisibleOrphanModules
ie_visible = VisibleOrphanModules
vis_mods } <- TcM InstEnvs
tcGetInstEnvs
        ; (FamInstEnv
pkg_fie, FamInstEnv
home_fie) <- TcM FamInstEnvs
tcGetFamInstEnvs
                -- Load all instances for all classes that are
                -- in the type environment (which are all the ones
                -- we've seen in any interface file so far)

          -- Return only the instances relevant to the given thing, i.e.
          -- the instances whose head contains the thing's name.
        ; let cls_insts :: [ClsInst]
cls_insts =
                 [ ClsInst
ispec        -- Search all
                 | ClsInst
ispec <- InstEnv -> [ClsInst]
instEnvElts InstEnv
home_ie [ClsInst] -> [ClsInst] -> [ClsInst]
forall a. [a] -> [a] -> [a]
++ InstEnv -> [ClsInst]
instEnvElts InstEnv
pkg_ie
                 , VisibleOrphanModules -> ClsInst -> Bool
instIsVisible VisibleOrphanModules
vis_mods ClsInst
ispec
                 , Name
tc_name Name -> FreeVars -> Bool
`elemNameSet` ClsInst -> FreeVars
orphNamesOfClsInst ClsInst
ispec ]
        ; let fam_insts :: [FamInst]
fam_insts =
                 [ FamInst
fispec
                 | FamInst
fispec <- FamInstEnv -> [FamInst]
famInstEnvElts FamInstEnv
home_fie [FamInst] -> [FamInst] -> [FamInst]
forall a. [a] -> [a] -> [a]
++ FamInstEnv -> [FamInst]
famInstEnvElts FamInstEnv
pkg_fie
                 , Name
tc_name Name -> FreeVars -> Bool
`elemNameSet` FamInst -> FreeVars
orphNamesOfFamInst FamInst
fispec ]
        ; ([ClsInst], [FamInst]) -> TcM ([ClsInst], [FamInst])
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ([ClsInst]
cls_insts, [FamInst]
fam_insts) }
  where
    tc_name :: Name
tc_name     = TyCon -> Name
tyConName TyCon
tc

lookupInsts TyThing
_ = ([ClsInst], [FamInst]) -> TcM ([ClsInst], [FamInst])
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return ([],[])

loadUnqualIfaces :: HscEnv -> InteractiveContext -> TcM ()
-- Load the interface for everything that is in scope unqualified
-- This is so that we can accurately report the instances for
-- something
loadUnqualIfaces :: HscEnv -> InteractiveContext -> IOEnv (Env TcGblEnv TcLclEnv) ()
loadUnqualIfaces HscEnv
hsc_env InteractiveContext
ictxt
  = IfG () -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a. IfG a -> TcRn a
initIfaceTcRn (IfG () -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IfG () -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
    (Module -> IOEnv (Env IfGblEnv ()) (ModIface_ 'ModIfaceFinal))
-> [Module] -> IfG ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ (SDoc
-> Module -> IOEnv (Env IfGblEnv ()) (ModIface_ 'ModIfaceFinal)
forall lcl. SDoc -> Module -> IfM lcl (ModIface_ 'ModIfaceFinal)
loadSysInterface SDoc
doc) (VisibleOrphanModules -> [Module]
moduleSetElts ([Module] -> VisibleOrphanModules
mkModuleSet [Module]
unqual_mods))
  where
    home_unit :: HomeUnit
home_unit = HscEnv -> HomeUnit
hsc_home_unit HscEnv
hsc_env

    unqual_mods :: [Module]
unqual_mods = [ HasDebugCallStack => Name -> Module
Name -> Module
nameModule Name
name
                  | GlobalRdrElt
gre <- GlobalRdrEnv -> [GlobalRdrElt]
forall info. GlobalRdrEnvX info -> [GlobalRdrEltX info]
globalRdrEnvElts (InteractiveContext -> GlobalRdrEnv
icReaderEnv InteractiveContext
ictxt)
                  , let name :: Name
name = GlobalRdrElt -> Name
forall info. GlobalRdrEltX info -> Name
greName GlobalRdrElt
gre
                  , HomeUnit -> Name -> Bool
nameIsFromExternalPackage HomeUnit
home_unit Name
name
                  , OccName -> Bool
isTcOcc (Name -> OccName
nameOccName Name
name)   -- Types and classes only
                  , GlobalRdrElt -> Bool
forall info. GlobalRdrEltX info -> Bool
unQualOK GlobalRdrElt
gre ]               -- In scope unqualified
    doc :: SDoc
doc = String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"Need interface for module whose export(s) are in scope unqualified"



{-
************************************************************************
*                                                                      *
                Debugging output
      This is what happens when you do -ddump-types
*                                                                      *
************************************************************************
-}

-- | Dump, with a banner, if -ddump-rn
rnDump :: (Outputable a, Data a) => a -> TcRn ()
rnDump :: forall a.
(Outputable a, Data a) =>
a -> IOEnv (Env TcGblEnv TcLclEnv) ()
rnDump a
rn = DumpFlag
-> String -> DumpFormat -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
dumpOptTcRn DumpFlag
Opt_D_dump_rn String
"Renamer" DumpFormat
FormatHaskell (a -> SDoc
forall a. Outputable a => a -> SDoc
ppr a
rn)

tcDump :: TcGblEnv -> TcRn ()
tcDump :: TcGblEnv -> IOEnv (Env TcGblEnv TcLclEnv) ()
tcDump TcGblEnv
env
 = do { UnitState
unit_state <- HasDebugCallStack => HscEnv -> UnitState
HscEnv -> UnitState
hsc_units (HscEnv -> UnitState)
-> TcRnIf TcGblEnv TcLclEnv HscEnv
-> IOEnv (Env TcGblEnv TcLclEnv) UnitState
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> TcRnIf TcGblEnv TcLclEnv HscEnv
forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv ;
        Logger
logger <- IOEnv (Env TcGblEnv TcLclEnv) Logger
forall (m :: * -> *). HasLogger m => m Logger
getLogger ;

        -- Dump short output if -ddump-types or -ddump-tc
        Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (Logger -> DumpFlag -> Bool
logHasDumpFlag Logger
logger DumpFlag
Opt_D_dump_types Bool -> Bool -> Bool
|| Logger -> DumpFlag -> Bool
logHasDumpFlag Logger
logger DumpFlag
Opt_D_dump_tc)
          (Bool
-> DumpFlag
-> String
-> DumpFormat
-> SDoc
-> IOEnv (Env TcGblEnv TcLclEnv) ()
dumpTcRn Bool
True DumpFlag
Opt_D_dump_types
            String
"" DumpFormat
FormatText (UnitState -> SDoc -> SDoc
pprWithUnitState UnitState
unit_state SDoc
short_dump)) ;

        -- Dump bindings if -ddump-tc
        DumpFlag
-> String -> DumpFormat -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
dumpOptTcRn DumpFlag
Opt_D_dump_tc String
"Typechecker" DumpFormat
FormatHaskell SDoc
full_dump;

        -- Dump bindings as an hsSyn AST if -ddump-tc-ast
        DumpFlag
-> String -> DumpFormat -> SDoc -> IOEnv (Env TcGblEnv TcLclEnv) ()
dumpOptTcRn DumpFlag
Opt_D_dump_tc_ast String
"Typechecker AST" DumpFormat
FormatHaskell SDoc
ast_dump
   }
  where
    short_dump :: SDoc
short_dump = TcGblEnv -> SDoc
pprTcGblEnv TcGblEnv
env
    full_dump :: SDoc
full_dump  = LHsBinds GhcTc -> SDoc
forall (idL :: Pass) (idR :: Pass).
(OutputableBndrId idL, OutputableBndrId idR) =>
LHsBindsLR (GhcPass idL) (GhcPass idR) -> SDoc
pprLHsBinds (TcGblEnv -> LHsBinds GhcTc
tcg_binds TcGblEnv
env)
        -- NB: foreign x-d's have undefined's in their types;
        --     hence can't show the tc_fords
    ast_dump :: SDoc
ast_dump = BlankSrcSpan
-> BlankEpAnnotations
-> Bag (GenLocated SrcSpanAnnA (HsBindLR GhcTc GhcTc))
-> SDoc
forall a. Data a => BlankSrcSpan -> BlankEpAnnotations -> a -> SDoc
showAstData BlankSrcSpan
NoBlankSrcSpan BlankEpAnnotations
NoBlankEpAnnotations (TcGblEnv -> LHsBinds GhcTc
tcg_binds TcGblEnv
env)

-- It's unpleasant having both pprModGuts and pprModDetails here
pprTcGblEnv :: TcGblEnv -> SDoc
pprTcGblEnv :: TcGblEnv -> SDoc
pprTcGblEnv (TcGblEnv { tcg_type_env :: TcGblEnv -> TypeEnv
tcg_type_env  = TypeEnv
type_env,
                        tcg_insts :: TcGblEnv -> [ClsInst]
tcg_insts     = [ClsInst]
insts,
                        tcg_fam_insts :: TcGblEnv -> [FamInst]
tcg_fam_insts = [FamInst]
fam_insts,
                        tcg_rules :: TcGblEnv -> [LRuleDecl GhcTc]
tcg_rules     = [LRuleDecl GhcTc]
rules,
                        tcg_imports :: TcGblEnv -> ImportAvails
tcg_imports   = ImportAvails
imports })
  = (Bool -> SDoc) -> SDoc
forall doc. IsOutput doc => (Bool -> doc) -> doc
getPprDebug ((Bool -> SDoc) -> SDoc) -> (Bool -> SDoc) -> SDoc
forall a b. (a -> b) -> a -> b
$ \Bool
debug ->
    [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat [ Bool -> TypeEnv -> SDoc
ppr_types Bool
debug TypeEnv
type_env
         , Bool -> [FamInst] -> TypeEnv -> SDoc
ppr_tycons Bool
debug [FamInst]
fam_insts TypeEnv
type_env
         , Bool -> TypeEnv -> SDoc
ppr_datacons Bool
debug TypeEnv
type_env
         , TypeEnv -> SDoc
ppr_patsyns TypeEnv
type_env
         , [ClsInst] -> SDoc
ppr_insts [ClsInst]
insts
         , [FamInst] -> SDoc
ppr_fam_insts [FamInst]
fam_insts
         , [LRuleDecl GhcTc] -> SDoc
ppr_rules [LRuleDecl GhcTc]
rules
         , String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"Dependent modules:" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+>
                ([(InstalledModule, ModuleNameWithIsBoot)] -> SDoc
forall a. Outputable a => a -> SDoc
ppr ([(InstalledModule, ModuleNameWithIsBoot)] -> SDoc)
-> (InstalledModuleEnv ModuleNameWithIsBoot
    -> [(InstalledModule, ModuleNameWithIsBoot)])
-> InstalledModuleEnv ModuleNameWithIsBoot
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [(InstalledModule, ModuleNameWithIsBoot)]
-> [(InstalledModule, ModuleNameWithIsBoot)]
forall a. Ord a => [a] -> [a]
sort ([(InstalledModule, ModuleNameWithIsBoot)]
 -> [(InstalledModule, ModuleNameWithIsBoot)])
-> (InstalledModuleEnv ModuleNameWithIsBoot
    -> [(InstalledModule, ModuleNameWithIsBoot)])
-> InstalledModuleEnv ModuleNameWithIsBoot
-> [(InstalledModule, ModuleNameWithIsBoot)]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. InstalledModuleEnv ModuleNameWithIsBoot
-> [(InstalledModule, ModuleNameWithIsBoot)]
forall a. InstalledModuleEnv a -> [(InstalledModule, a)]
installedModuleEnvElts (InstalledModuleEnv ModuleNameWithIsBoot -> SDoc)
-> InstalledModuleEnv ModuleNameWithIsBoot -> SDoc
forall a b. (a -> b) -> a -> b
$ ImportAvails -> InstalledModuleEnv ModuleNameWithIsBoot
imp_direct_dep_mods ImportAvails
imports)
         , String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"Dependent packages:" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+>
                [UnitId] -> SDoc
forall a. Outputable a => a -> SDoc
ppr (Set UnitId -> [UnitId]
forall a. Set a -> [a]
S.toList (Set UnitId -> [UnitId]) -> Set UnitId -> [UnitId]
forall a b. (a -> b) -> a -> b
$ ImportAvails -> Set UnitId
imp_dep_direct_pkgs ImportAvails
imports)]
                -- The use of sort is just to reduce unnecessary
                -- wobbling in testsuite output

ppr_rules :: [LRuleDecl GhcTc] -> SDoc
ppr_rules :: [LRuleDecl GhcTc] -> SDoc
ppr_rules [LRuleDecl GhcTc]
rules
  = Bool -> SDoc -> SDoc
forall doc. IsOutput doc => Bool -> doc -> doc
ppUnless ([GenLocated SrcSpanAnnA (RuleDecl GhcTc)] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LRuleDecl GhcTc]
[GenLocated SrcSpanAnnA (RuleDecl GhcTc)]
rules) (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$
    SDoc -> Arity -> SDoc -> SDoc
hang (String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"RULES")
       Arity
2 ([SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat ((GenLocated SrcSpanAnnA (RuleDecl GhcTc) -> SDoc)
-> [GenLocated SrcSpanAnnA (RuleDecl GhcTc)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map GenLocated SrcSpanAnnA (RuleDecl GhcTc) -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LRuleDecl GhcTc]
[GenLocated SrcSpanAnnA (RuleDecl GhcTc)]
rules))

ppr_types :: Bool -> TypeEnv -> SDoc
ppr_types :: Bool -> TypeEnv -> SDoc
ppr_types Bool
debug TypeEnv
type_env
  = String -> (Var -> SDoc) -> [Var] -> SDoc
forall a. String -> (a -> SDoc) -> [a] -> SDoc
ppr_things String
"TYPE SIGNATURES" Var -> SDoc
ppr_sig
             ((Var -> Var -> Ordering) -> [Var] -> [Var]
forall a. (a -> a -> Ordering) -> [a] -> [a]
sortBy ((Var -> OccName) -> Var -> Var -> Ordering
forall a b. Ord a => (b -> a) -> b -> b -> Ordering
comparing Var -> OccName
forall a. NamedThing a => a -> OccName
getOccName) [Var]
ids)
  where
    ids :: [Var]
ids = [Var
id | Var
id <- TypeEnv -> [Var]
typeEnvIds TypeEnv
type_env, Var -> Bool
want_sig Var
id]
    want_sig :: Var -> Bool
want_sig Var
id
      | Bool
debug     = Bool
True
      | Bool
otherwise = Var -> Bool
forall x. NamedThing x => x -> Bool
hasTopUserName Var
id
                    Bool -> Bool -> Bool
&& case Var -> IdDetails
idDetails Var
id of
                         IdDetails
VanillaId              -> Bool
True
                         WorkerLikeId {}        -> Bool
True
                         RecSelId {}            -> Bool
True
                         ClassOpId {}           -> Bool
True
                         FCallId {}             -> Bool
True
                         IdDetails
_                      -> Bool
False
             -- Data cons (workers and wrappers), pattern synonyms,
             -- etc are suppressed (unless -dppr-debug),
             -- because they appear elsewhere

    ppr_sig :: Var -> SDoc
ppr_sig Var
id = SDoc -> Arity -> SDoc -> SDoc
hang (Var -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc Var
id SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> SDoc
dcolon) Arity
2 (Type -> SDoc
forall a. Outputable a => a -> SDoc
ppr (Type -> Type
tidyTopType (Var -> Type
idType Var
id)))

ppr_tycons :: Bool -> [FamInst] -> TypeEnv -> SDoc
ppr_tycons :: Bool -> [FamInst] -> TypeEnv -> SDoc
ppr_tycons Bool
debug [FamInst]
fam_insts TypeEnv
type_env
  = [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat [ String -> (TyCon -> SDoc) -> [TyCon] -> SDoc
forall a. String -> (a -> SDoc) -> [a] -> SDoc
ppr_things String
"TYPE CONSTRUCTORS" TyCon -> SDoc
ppr_tc [TyCon]
tycons
         , String -> (CoAxiom Branched -> SDoc) -> [CoAxiom Branched] -> SDoc
forall a. String -> (a -> SDoc) -> [a] -> SDoc
ppr_things String
"COERCION AXIOMS" CoAxiom Branched -> SDoc
forall {br :: BranchFlag}. CoAxiom br -> SDoc
ppr_ax
                      (TypeEnv -> [CoAxiom Branched]
typeEnvCoAxioms TypeEnv
type_env) ]
  where
    fi_tycons :: [TyCon]
fi_tycons = [FamInst] -> [TyCon]
famInstsRepTyCons [FamInst]
fam_insts

    tycons :: [TyCon]
tycons = (TyCon -> TyCon -> Ordering) -> [TyCon] -> [TyCon]
forall a. (a -> a -> Ordering) -> [a] -> [a]
sortBy ((TyCon -> OccName) -> TyCon -> TyCon -> Ordering
forall a b. Ord a => (b -> a) -> b -> b -> Ordering
comparing TyCon -> OccName
forall a. NamedThing a => a -> OccName
getOccName) ([TyCon] -> [TyCon]) -> [TyCon] -> [TyCon]
forall a b. (a -> b) -> a -> b
$
             [TyCon
tycon | TyCon
tycon <- TypeEnv -> [TyCon]
typeEnvTyCons TypeEnv
type_env
                    , TyCon -> Bool
want_tycon TyCon
tycon]
             -- Sort by OccName to reduce unnecessary changes
    want_tycon :: TyCon -> Bool
want_tycon TyCon
tycon | Bool
debug      = Bool
True
                     | Bool
otherwise  = Name -> Bool
isExternalName (TyCon -> Name
tyConName TyCon
tycon) Bool -> Bool -> Bool
&&
                                    Bool -> Bool
not (TyCon
tycon TyCon -> [TyCon] -> Bool
forall a. Eq a => a -> [a] -> Bool
forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [TyCon]
fi_tycons)
    ppr_tc :: TyCon -> SDoc
ppr_tc TyCon
tc
       = [SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat [ SDoc -> Arity -> SDoc -> SDoc
hang (TyConFlavour TyCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr (TyCon -> TyConFlavour TyCon
tyConFlavour TyCon
tc) SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> Name -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc (TyCon -> Name
tyConName TyCon
tc)
                      SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc
braces (Arity -> SDoc
forall a. Outputable a => a -> SDoc
ppr (TyCon -> Arity
tyConArity TyCon
tc)) SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> SDoc
dcolon)
                   Arity
2 (Type -> SDoc
forall a. Outputable a => a -> SDoc
ppr (Type -> Type
tidyTopType (TyCon -> Type
tyConKind TyCon
tc)))
              , Arity -> SDoc -> SDoc
nest Arity
2 (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$
                Bool -> SDoc -> SDoc
forall doc. IsOutput doc => Bool -> doc -> doc
ppWhen Bool
show_roles (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$
                String -> SDoc
forall doc. IsLine doc => String -> doc
text String
"roles" SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> ([SDoc] -> SDoc
forall doc. IsLine doc => [doc] -> doc
sep ((Role -> SDoc) -> [Role] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map Role -> SDoc
forall a. Outputable a => a -> SDoc
ppr [Role]
roles)) ]
       where
         show_roles :: Bool
show_roles = Bool
debug Bool -> Bool -> Bool
|| Bool -> Bool
not ((Role -> Bool) -> [Role] -> Bool
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
all (Role -> Role -> Bool
forall a. Eq a => a -> a -> Bool
== Role
boring_role) [Role]
roles)
         roles :: [Role]
roles = TyCon -> [Role]
tyConRoles TyCon
tc
         boring_role :: Role
boring_role | TyCon -> Bool
isClassTyCon TyCon
tc = Role
Nominal
                     | Bool
otherwise       = Role
Representational
            -- Matches the choice in GHC.Iface.Syntax, calls to pprRoles

    ppr_ax :: CoAxiom br -> SDoc
ppr_ax CoAxiom br
ax = IfaceDecl -> SDoc
forall a. Outputable a => a -> SDoc
ppr (CoAxiom br -> IfaceDecl
forall (br :: BranchFlag). CoAxiom br -> IfaceDecl
coAxiomToIfaceDecl CoAxiom br
ax)
      -- We go via IfaceDecl rather than using pprCoAxiom
      -- This way we get the full axiom (both LHS and RHS) with
      -- wildcard binders tidied to _1, _2, etc.

ppr_datacons :: Bool -> TypeEnv -> SDoc
ppr_datacons :: Bool -> TypeEnv -> SDoc
ppr_datacons Bool
debug TypeEnv
type_env
  = String -> (DataCon -> SDoc) -> [DataCon] -> SDoc
forall a. String -> (a -> SDoc) -> [a] -> SDoc
ppr_things String
"DATA CONSTRUCTORS" DataCon -> SDoc
ppr_dc [DataCon]
wanted_dcs
      -- The filter gets rid of class data constructors
  where
    ppr_dc :: DataCon -> SDoc
ppr_dc DataCon
dc = (SDocContext -> Bool) -> (Bool -> SDoc) -> SDoc
forall a. (SDocContext -> a) -> (a -> SDoc) -> SDoc
sdocOption SDocContext -> Bool
sdocLinearTypes (\Bool
show_linear_types ->
                DataCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr DataCon
dc SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> SDoc
dcolon SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> Type -> SDoc
forall a. Outputable a => a -> SDoc
ppr (Bool -> DataCon -> Type
dataConDisplayType Bool
show_linear_types DataCon
dc))
    all_dcs :: [DataCon]
all_dcs    = TypeEnv -> [DataCon]
typeEnvDataCons TypeEnv
type_env
    wanted_dcs :: [DataCon]
wanted_dcs | Bool
debug     = [DataCon]
all_dcs
               | Bool
otherwise = (DataCon -> Bool) -> [DataCon] -> [DataCon]
forall a. (a -> Bool) -> [a] -> [a]
filterOut DataCon -> Bool
is_cls_dc [DataCon]
all_dcs
    is_cls_dc :: DataCon -> Bool
is_cls_dc DataCon
dc = TyCon -> Bool
isClassTyCon (DataCon -> TyCon
dataConTyCon DataCon
dc)

ppr_patsyns :: TypeEnv -> SDoc
ppr_patsyns :: TypeEnv -> SDoc
ppr_patsyns TypeEnv
type_env
  = String -> (PatSyn -> SDoc) -> [PatSyn] -> SDoc
forall a. String -> (a -> SDoc) -> [a] -> SDoc
ppr_things String
"PATTERN SYNONYMS" PatSyn -> SDoc
ppr_ps
               (TypeEnv -> [PatSyn]
typeEnvPatSyns TypeEnv
type_env)
  where
    ppr_ps :: PatSyn -> SDoc
ppr_ps PatSyn
ps = PatSyn -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc PatSyn
ps SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> SDoc
dcolon SDoc -> SDoc -> SDoc
forall doc. IsLine doc => doc -> doc -> doc
<+> PatSyn -> SDoc
pprPatSynType PatSyn
ps

ppr_insts :: [ClsInst] -> SDoc
ppr_insts :: [ClsInst] -> SDoc
ppr_insts [ClsInst]
ispecs
  = String -> (ClsInst -> SDoc) -> [ClsInst] -> SDoc
forall a. String -> (a -> SDoc) -> [a] -> SDoc
ppr_things String
"CLASS INSTANCES" ClsInst -> SDoc
pprInstance [ClsInst]
ispecs

ppr_fam_insts :: [FamInst] -> SDoc
ppr_fam_insts :: [FamInst] -> SDoc
ppr_fam_insts [FamInst]
fam_insts
  = String -> (FamInst -> SDoc) -> [FamInst] -> SDoc
forall a. String -> (a -> SDoc) -> [a] -> SDoc
ppr_things String
"FAMILY INSTANCES" FamInst -> SDoc
pprFamInst [FamInst]
fam_insts

ppr_things :: String -> (a -> SDoc) -> [a] -> SDoc
ppr_things :: forall a. String -> (a -> SDoc) -> [a] -> SDoc
ppr_things String
herald a -> SDoc
ppr_one [a]
things
  | [a] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [a]
things = SDoc
forall doc. IsOutput doc => doc
empty
  | Bool
otherwise   = String -> SDoc
forall doc. IsLine doc => String -> doc
text String
herald SDoc -> SDoc -> SDoc
forall doc. IsDoc doc => doc -> doc -> doc
$$ Arity -> SDoc -> SDoc
nest Arity
2 ([SDoc] -> SDoc
forall doc. IsDoc doc => [doc] -> doc
vcat ((a -> SDoc) -> [a] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map a -> SDoc
ppr_one [a]
things))

hasTopUserName :: NamedThing x => x -> Bool
-- A top-level thing whose name is not "derived"
-- Thus excluding things like $tcX, from Typeable boilerplate
-- and C:Coll from class-dictionary data constructors
hasTopUserName :: forall x. NamedThing x => x -> Bool
hasTopUserName x
x
  = Name -> Bool
isExternalName Name
name Bool -> Bool -> Bool
&& Bool -> Bool
not (OccName -> Bool
isDerivedOccName (Name -> OccName
nameOccName Name
name))
  where
    name :: Name
name = x -> Name
forall a. NamedThing a => a -> Name
getName x
x

{-
********************************************************************************

Type Checker Plugins

********************************************************************************
-}

withTcPlugins :: HscEnv -> TcM a -> TcM a
withTcPlugins :: forall a. HscEnv -> TcM a -> TcM a
withTcPlugins HscEnv
hsc_env TcM a
m =
    case [Maybe TcPlugin] -> [TcPlugin]
forall a. [Maybe a] -> [a]
catMaybes ([Maybe TcPlugin] -> [TcPlugin]) -> [Maybe TcPlugin] -> [TcPlugin]
forall a b. (a -> b) -> a -> b
$ Plugins
-> (Plugin -> [String] -> Maybe TcPlugin) -> [Maybe TcPlugin]
forall a. Plugins -> (Plugin -> [String] -> a) -> [a]
mapPlugins (HscEnv -> Plugins
hsc_plugins HscEnv
hsc_env) Plugin -> [String] -> Maybe TcPlugin
tcPlugin of
       []      -> TcM a
m  -- Common fast case
       [TcPlugin]
plugins -> do
                ([TcPluginSolver]
solvers, [UniqFM TyCon TcPluginRewriter]
rewriters, [TcPluginM ()]
stops) <-
                  [(TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ())]
-> ([TcPluginSolver], [UniqFM TyCon TcPluginRewriter],
    [TcPluginM ()])
forall a b c. [(a, b, c)] -> ([a], [b], [c])
unzip3 ([(TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ())]
 -> ([TcPluginSolver], [UniqFM TyCon TcPluginRewriter],
     [TcPluginM ()]))
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     [(TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ())]
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     ([TcPluginSolver], [UniqFM TyCon TcPluginRewriter], [TcPluginM ()])
forall a b.
(a -> b)
-> IOEnv (Env TcGblEnv TcLclEnv) a
-> IOEnv (Env TcGblEnv TcLclEnv) b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
`fmap` (TcPlugin
 -> IOEnv
      (Env TcGblEnv TcLclEnv)
      (TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ()))
-> [TcPlugin]
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     [(TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ())]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> [a] -> m [b]
mapM TcPlugin
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ())
start_plugin [TcPlugin]
plugins
                let
                  rewritersUniqFM :: UniqFM TyCon [TcPluginRewriter]
                  !rewritersUniqFM :: UniqFM TyCon [TcPluginRewriter]
rewritersUniqFM = [UniqFM TyCon TcPluginRewriter] -> UniqFM TyCon [TcPluginRewriter]
forall key elt. [UniqFM key elt] -> UniqFM key [elt]
sequenceUFMList [UniqFM TyCon TcPluginRewriter]
rewriters
                -- The following ensures that tcPluginStop is called even if a type
                -- error occurs during compilation (Fix of #10078)
                Either IOEnvFailure a
eitherRes <- TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a)
forall env r. IOEnv env r -> IOEnv env (Either IOEnvFailure r)
tryM (TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a))
-> TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a)
forall a b. (a -> b) -> a -> b
$
                  (TcGblEnv -> TcGblEnv) -> TcM a -> TcM a
forall gbl lcl a.
(gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
updGblEnv (\TcGblEnv
e -> TcGblEnv
e { tcg_tc_plugin_solvers   = solvers
                                     , tcg_tc_plugin_rewriters = rewritersUniqFM }) TcM a
m
                (TcPluginM () -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> [TcPluginM ()] -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ TcPluginM () -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a. TcPluginM a -> TcM a
runTcPluginM [TcPluginM ()]
stops
                case Either IOEnvFailure a
eitherRes of
                  Left IOEnvFailure
_ -> TcM a
forall env a. IOEnv env a
failM
                  Right a
res -> a -> TcM a
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return a
res
  where
  start_plugin :: TcPlugin
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ())
start_plugin (TcPlugin TcPluginM s
start s -> TcPluginSolver
solve s -> UniqFM TyCon TcPluginRewriter
rewrite s -> TcPluginM ()
stop) =
    do s
s <- TcPluginM s -> TcM s
forall a. TcPluginM a -> TcM a
runTcPluginM TcPluginM s
start
       (TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ())
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (TcPluginSolver, UniqFM TyCon TcPluginRewriter, TcPluginM ())
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (s -> TcPluginSolver
solve s
s, s -> UniqFM TyCon TcPluginRewriter
rewrite s
s, s -> TcPluginM ()
stop s
s)

withDefaultingPlugins :: HscEnv -> TcM a -> TcM a
withDefaultingPlugins :: forall a. HscEnv -> TcM a -> TcM a
withDefaultingPlugins HscEnv
hsc_env TcM a
m =
  do case [Maybe DefaultingPlugin] -> [DefaultingPlugin]
forall a. [Maybe a] -> [a]
catMaybes ([Maybe DefaultingPlugin] -> [DefaultingPlugin])
-> [Maybe DefaultingPlugin] -> [DefaultingPlugin]
forall a b. (a -> b) -> a -> b
$ Plugins
-> (Plugin -> [String] -> Maybe DefaultingPlugin)
-> [Maybe DefaultingPlugin]
forall a. Plugins -> (Plugin -> [String] -> a) -> [a]
mapPlugins (HscEnv -> Plugins
hsc_plugins HscEnv
hsc_env) Plugin -> [String] -> Maybe DefaultingPlugin
defaultingPlugin of
       [] -> TcM a
m  -- Common fast case
       [DefaultingPlugin]
plugins  -> do ([FillDefaulting]
plugins,[TcPluginM ()]
stops) <- (DefaultingPlugin
 -> IOEnv (Env TcGblEnv TcLclEnv) (FillDefaulting, TcPluginM ()))
-> [DefaultingPlugin]
-> IOEnv (Env TcGblEnv TcLclEnv) ([FillDefaulting], [TcPluginM ()])
forall (m :: * -> *) a b c.
Applicative m =>
(a -> m (b, c)) -> [a] -> m ([b], [c])
mapAndUnzipM DefaultingPlugin
-> IOEnv (Env TcGblEnv TcLclEnv) (FillDefaulting, TcPluginM ())
start_plugin [DefaultingPlugin]
plugins
                      -- This ensures that dePluginStop is called even if a type
                      -- error occurs during compilation
                      Either IOEnvFailure a
eitherRes <- TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a)
forall env r. IOEnv env r -> IOEnv env (Either IOEnvFailure r)
tryM (TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a))
-> TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a)
forall a b. (a -> b) -> a -> b
$ do
                        (TcGblEnv -> TcGblEnv) -> TcM a -> TcM a
forall gbl lcl a.
(gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
updGblEnv (\TcGblEnv
e -> TcGblEnv
e { tcg_defaulting_plugins = plugins }) TcM a
m
                      (TcPluginM () -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> [TcPluginM ()] -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ TcPluginM () -> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a. TcPluginM a -> TcM a
runTcPluginM [TcPluginM ()]
stops
                      case Either IOEnvFailure a
eitherRes of
                        Left IOEnvFailure
_ -> TcM a
forall env a. IOEnv env a
failM
                        Right a
res -> a -> TcM a
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return a
res
  where
  start_plugin :: DefaultingPlugin
-> IOEnv (Env TcGblEnv TcLclEnv) (FillDefaulting, TcPluginM ())
start_plugin (DefaultingPlugin TcPluginM s
start s -> FillDefaulting
fill s -> TcPluginM ()
stop) =
    do s
s <- TcPluginM s -> TcM s
forall a. TcPluginM a -> TcM a
runTcPluginM TcPluginM s
start
       (FillDefaulting, TcPluginM ())
-> IOEnv (Env TcGblEnv TcLclEnv) (FillDefaulting, TcPluginM ())
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (s -> FillDefaulting
fill s
s, s -> TcPluginM ()
stop s
s)

withHoleFitPlugins :: HscEnv -> TcM a -> TcM a
withHoleFitPlugins :: forall a. HscEnv -> TcM a -> TcM a
withHoleFitPlugins HscEnv
hsc_env TcM a
m =
  case [Maybe HoleFitPluginR] -> [HoleFitPluginR]
forall a. [Maybe a] -> [a]
catMaybes ([Maybe HoleFitPluginR] -> [HoleFitPluginR])
-> [Maybe HoleFitPluginR] -> [HoleFitPluginR]
forall a b. (a -> b) -> a -> b
$ Plugins
-> (Plugin -> [String] -> Maybe HoleFitPluginR)
-> [Maybe HoleFitPluginR]
forall a. Plugins -> (Plugin -> [String] -> a) -> [a]
mapPlugins (HscEnv -> Plugins
hsc_plugins HscEnv
hsc_env) Plugin -> [String] -> Maybe HoleFitPluginR
holeFitPlugin of
    [] -> TcM a
m  -- Common fast case
    [HoleFitPluginR]
plugins -> do ([HoleFitPlugin]
plugins,[IOEnv (Env TcGblEnv TcLclEnv) ()]
stops) <- (HoleFitPluginR
 -> IOEnv
      (Env TcGblEnv TcLclEnv)
      (HoleFitPlugin, IOEnv (Env TcGblEnv TcLclEnv) ()))
-> [HoleFitPluginR]
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     ([HoleFitPlugin], [IOEnv (Env TcGblEnv TcLclEnv) ()])
forall (m :: * -> *) a b c.
Applicative m =>
(a -> m (b, c)) -> [a] -> m ([b], [c])
mapAndUnzipM HoleFitPluginR
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (HoleFitPlugin, IOEnv (Env TcGblEnv TcLclEnv) ())
start_plugin [HoleFitPluginR]
plugins
                  -- This ensures that hfPluginStop is called even if a type
                  -- error occurs during compilation.
                  Either IOEnvFailure a
eitherRes <- TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a)
forall env r. IOEnv env r -> IOEnv env (Either IOEnvFailure r)
tryM (TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a))
-> TcM a -> IOEnv (Env TcGblEnv TcLclEnv) (Either IOEnvFailure a)
forall a b. (a -> b) -> a -> b
$
                    (TcGblEnv -> TcGblEnv) -> TcM a -> TcM a
forall gbl lcl a.
(gbl -> gbl) -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
updGblEnv (\TcGblEnv
e -> TcGblEnv
e { tcg_hf_plugins = plugins }) TcM a
m
                  [IOEnv (Env TcGblEnv TcLclEnv) ()]
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (t :: * -> *) (m :: * -> *) a.
(Foldable t, Monad m) =>
t (m a) -> m ()
sequence_ [IOEnv (Env TcGblEnv TcLclEnv) ()]
stops
                  case Either IOEnvFailure a
eitherRes of
                    Left IOEnvFailure
_ -> TcM a
forall env a. IOEnv env a
failM
                    Right a
res -> a -> TcM a
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return a
res
  where
    start_plugin :: HoleFitPluginR
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (HoleFitPlugin, IOEnv (Env TcGblEnv TcLclEnv) ())
start_plugin (HoleFitPluginR TcM (TcRef s)
init TcRef s -> HoleFitPlugin
plugin TcRef s -> IOEnv (Env TcGblEnv TcLclEnv) ()
stop) =
      do TcRef s
ref <- TcM (TcRef s)
init
         (HoleFitPlugin, IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv
     (Env TcGblEnv TcLclEnv)
     (HoleFitPlugin, IOEnv (Env TcGblEnv TcLclEnv) ())
forall a. a -> IOEnv (Env TcGblEnv TcLclEnv) a
forall (m :: * -> *) a. Monad m => a -> m a
return (TcRef s -> HoleFitPlugin
plugin TcRef s
ref, TcRef s -> IOEnv (Env TcGblEnv TcLclEnv) ()
stop TcRef s
ref)


runRenamerPlugin :: TcGblEnv
                 -> HsGroup GhcRn
                 -> TcM (TcGblEnv, HsGroup GhcRn)
runRenamerPlugin :: TcGblEnv
-> HsGroup (GhcPass 'Renamed)
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
runRenamerPlugin TcGblEnv
gbl_env HsGroup (GhcPass 'Renamed)
hs_group = do
    HscEnv
hsc_env <- TcRnIf TcGblEnv TcLclEnv HscEnv
forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
    Plugins
-> PluginOperation
     (IOEnv (Env TcGblEnv TcLclEnv))
     (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall (m :: * -> *) a.
Monad m =>
Plugins -> PluginOperation m a -> a -> m a
withPlugins (HscEnv -> Plugins
hsc_plugins HscEnv
hsc_env)
      (\Plugin
p [String]
opts (TcGblEnv
e, HsGroup (GhcPass 'Renamed)
g) -> ( DynFlags -> IOEnv (Env TcGblEnv TcLclEnv) ()
mark_plugin_unsafe (HscEnv -> DynFlags
hsc_dflags HscEnv
hsc_env)
                            IOEnv (Env TcGblEnv TcLclEnv) ()
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
forall a b.
IOEnv (Env TcGblEnv TcLclEnv) a
-> IOEnv (Env TcGblEnv TcLclEnv) b
-> IOEnv (Env TcGblEnv TcLclEnv) b
forall (m :: * -> *) a b. Monad m => m a -> m b -> m b
>> Plugin
-> [String]
-> TcGblEnv
-> HsGroup (GhcPass 'Renamed)
-> TcM (TcGblEnv, HsGroup (GhcPass 'Renamed))
renamedResultAction Plugin
p [String]
opts TcGblEnv
e HsGroup (GhcPass 'Renamed)
g))
      (TcGblEnv
gbl_env, HsGroup (GhcPass 'Renamed)
hs_group)


-- XXX: should this really be a Maybe X?  Check under which circumstances this
-- can become a Nothing and decide whether this should instead throw an
-- exception/signal an error.
type RenamedStuff =
        (Maybe (HsGroup GhcRn, [LImportDecl GhcRn], Maybe [(LIE GhcRn, Avails)],
                Maybe (LHsDoc GhcRn)))

-- | Extract the renamed information from TcGblEnv.
getRenamedStuff :: TcGblEnv -> RenamedStuff
getRenamedStuff :: TcGblEnv -> RenamedStuff
getRenamedStuff TcGblEnv
tc_result
  = (HsGroup (GhcPass 'Renamed)
 -> (HsGroup (GhcPass 'Renamed),
     [GenLocated SrcSpanAnnA (ImportDecl (GhcPass 'Renamed))],
     Maybe
       [(GenLocated SrcSpanAnnA (IE (GhcPass 'Renamed)), [AvailInfo])],
     Maybe (GenLocated SrcSpan (HsDoc (GhcPass 'Renamed)))))
-> Maybe (HsGroup (GhcPass 'Renamed))
-> Maybe
     (HsGroup (GhcPass 'Renamed),
      [GenLocated SrcSpanAnnA (ImportDecl (GhcPass 'Renamed))],
      Maybe
        [(GenLocated SrcSpanAnnA (IE (GhcPass 'Renamed)), [AvailInfo])],
      Maybe (GenLocated SrcSpan (HsDoc (GhcPass 'Renamed))))
forall a b. (a -> b) -> Maybe a -> Maybe b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (\HsGroup (GhcPass 'Renamed)
decls -> ( HsGroup (GhcPass 'Renamed)
decls, TcGblEnv -> [LImportDecl (GhcPass 'Renamed)]
tcg_rn_imports TcGblEnv
tc_result
                    , TcGblEnv -> Maybe [(LIE (GhcPass 'Renamed), [AvailInfo])]
tcg_rn_exports TcGblEnv
tc_result, TcGblEnv -> Maybe (GenLocated SrcSpan (HsDoc (GhcPass 'Renamed)))
tcg_doc_hdr TcGblEnv
tc_result ) )
         (TcGblEnv -> Maybe (HsGroup (GhcPass 'Renamed))
tcg_rn_decls TcGblEnv
tc_result)

runTypecheckerPlugin :: ModSummary -> TcGblEnv -> TcM TcGblEnv
runTypecheckerPlugin :: ModSummary -> TcGblEnv -> TcM TcGblEnv
runTypecheckerPlugin ModSummary
sum TcGblEnv
gbl_env = do
    HscEnv
hsc_env <- TcRnIf TcGblEnv TcLclEnv HscEnv
forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
    Plugins
-> PluginOperation (IOEnv (Env TcGblEnv TcLclEnv)) TcGblEnv
-> TcGblEnv
-> TcM TcGblEnv
forall (m :: * -> *) a.
Monad m =>
Plugins -> PluginOperation m a -> a -> m a
withPlugins (HscEnv -> Plugins
hsc_plugins HscEnv
hsc_env)
      (\Plugin
p [String]
opts TcGblEnv
env -> DynFlags -> IOEnv (Env TcGblEnv TcLclEnv) ()
mark_plugin_unsafe (HscEnv -> DynFlags
hsc_dflags HscEnv
hsc_env)
                        IOEnv (Env TcGblEnv TcLclEnv) () -> TcM TcGblEnv -> TcM TcGblEnv
forall a b.
IOEnv (Env TcGblEnv TcLclEnv) a
-> IOEnv (Env TcGblEnv TcLclEnv) b
-> IOEnv (Env TcGblEnv TcLclEnv) b
forall (m :: * -> *) a b. Monad m => m a -> m b -> m b
>> Plugin -> [String] -> ModSummary -> TcGblEnv -> TcM TcGblEnv
typeCheckResultAction Plugin
p [String]
opts ModSummary
sum TcGblEnv
env)
      TcGblEnv
gbl_env

mark_plugin_unsafe :: DynFlags -> TcM ()
mark_plugin_unsafe :: DynFlags -> IOEnv (Env TcGblEnv TcLclEnv) ()
mark_plugin_unsafe DynFlags
dflags = Bool
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (GeneralFlag -> DynFlags -> Bool
gopt GeneralFlag
Opt_PluginTrustworthy DynFlags
dflags) (IOEnv (Env TcGblEnv TcLclEnv) ()
 -> IOEnv (Env TcGblEnv TcLclEnv) ())
-> IOEnv (Env TcGblEnv TcLclEnv) ()
-> IOEnv (Env TcGblEnv TcLclEnv) ()
forall a b. (a -> b) -> a -> b
$
  Messages TcRnMessage -> IOEnv (Env TcGblEnv TcLclEnv) ()
recordUnsafeInfer Messages TcRnMessage
pluginUnsafe
  where
    !diag_opts :: DiagOpts
diag_opts = DynFlags -> DiagOpts
initDiagOpts DynFlags
dflags
    pluginUnsafe :: Messages TcRnMessage
pluginUnsafe =
      MsgEnvelope TcRnMessage -> Messages TcRnMessage
forall e. MsgEnvelope e -> Messages e
singleMessage (MsgEnvelope TcRnMessage -> Messages TcRnMessage)
-> MsgEnvelope TcRnMessage -> Messages TcRnMessage
forall a b. (a -> b) -> a -> b
$
      DiagOpts -> SrcSpan -> TcRnMessage -> MsgEnvelope TcRnMessage
forall e. Diagnostic e => DiagOpts -> SrcSpan -> e -> MsgEnvelope e
mkPlainMsgEnvelope DiagOpts
diag_opts SrcSpan
noSrcSpan TcRnMessage
TcRnUnsafeDueToPlugin