{-# LANGUAGE CPP                    #-}
{-# LANGUAGE FlexibleInstances      #-}
{-# LANGUAGE FunctionalDependencies #-}
{-# LANGUAGE GADTs                  #-}
{-# LANGUAGE InstanceSigs           #-}
{-# LANGUAGE MultiWayIf             #-}
{-# LANGUAGE ScopedTypeVariables    #-}
{-# LANGUAGE TupleSections          #-}
{-# LANGUAGE TypeFamilies           #-}

{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-}

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

-}

-- | Template Haskell splices
module GHC.Tc.Gen.Splice(
     tcSpliceExpr, tcTypedBracket, tcUntypedBracket,
--     runQuasiQuoteExpr, runQuasiQuotePat,
--     runQuasiQuoteDecl, runQuasiQuoteType,
     runAnnotation,

     runMetaE, runMetaP, runMetaT, runMetaD, runQuasi,
     tcTopSpliceExpr, lookupThName_maybe,
     defaultRunMeta, runMeta', runRemoteModFinalizers,
     finishTH, runTopSplice
      ) where

#include "HsVersions.h"

import GHC.Prelude

import GHC.Driver.Plugins
import GHC.Driver.Main
import GHC.Driver.Session
import GHC.Driver.Env
import GHC.Driver.Hooks

import GHC.Hs

import GHC.Tc.Utils.Monad
import GHC.Tc.Utils.TcType
import GHC.Tc.Gen.Expr
import GHC.Tc.Utils.Unify
import GHC.Tc.Utils.Env
import GHC.Tc.Types.Origin
import GHC.Tc.Types.Evidence
import GHC.Tc.Utils.Zonk
import GHC.Tc.Solver
import GHC.Tc.Utils.TcMType
import GHC.Tc.Gen.HsType
import GHC.Tc.Instance.Family
import GHC.Tc.Utils.Instantiate

import GHC.Core.Multiplicity
import GHC.Core.Coercion( etaExpandCoAxBranch )
import GHC.Core.Type as Type
import GHC.Core.TyCo.Rep as TyCoRep
import GHC.Core.FamInstEnv
import GHC.Core.InstEnv as InstEnv

import GHC.Builtin.Names.TH
import GHC.Builtin.Names
import GHC.Builtin.Types

import GHC.ThToHs
import GHC.HsToCore.Docs
import GHC.HsToCore.Expr
import GHC.HsToCore.Monad
import GHC.IfaceToCore
import GHC.Iface.Load

import GHCi.Message
import GHCi.RemoteTypes
import GHC.Runtime.Interpreter

import GHC.Rename.Splice( traceSplice, SpliceInfo(..))
import GHC.Rename.Expr
import GHC.Rename.Env
import GHC.Rename.Utils  ( HsDocContext(..) )
import GHC.Rename.Fixity ( lookupFixityRn_help )
import GHC.Rename.HsType

import GHC.Core.Class
import GHC.Core.TyCon
import GHC.Core.Coercion.Axiom
import GHC.Core.PatSyn
import GHC.Core.ConLike
import GHC.Core.DataCon as DataCon

import GHC.Types.FieldLabel
import GHC.Types.SrcLoc
import GHC.Types.Name.Env
import GHC.Types.Name.Set
import GHC.Types.Name.Reader
import GHC.Types.Name.Occurrence as OccName
import GHC.Types.Var
import GHC.Types.Id
import GHC.Types.Id.Info
import GHC.Types.Unique
import GHC.Types.Var.Set
import GHC.Types.Meta
import GHC.Types.Basic hiding( SuccessFlag(..) )
import GHC.Types.Error
import GHC.Types.Fixity as Hs
import GHC.Types.Annotations
import GHC.Types.Name
import GHC.Serialized

import GHC.Unit.Finder
import GHC.Unit.Module
import GHC.Unit.Module.ModIface
import GHC.Unit.Module.Deps

import GHC.Utils.Misc
import GHC.Utils.Panic as Panic
import GHC.Utils.Lexeme
import GHC.Utils.Outputable
import GHC.Utils.Logger

import GHC.Utils.TmpFs ( newTempName, TempFileLifetime(..) )

import GHC.Data.FastString
import GHC.Data.Maybe( MaybeErr(..) )
import qualified GHC.Data.EnumSet as EnumSet

import qualified Language.Haskell.TH as TH
-- THSyntax gives access to internal functions and data types
import qualified Language.Haskell.TH.Syntax as TH

#if defined(HAVE_INTERNAL_INTERPRETER)
-- Because GHC.Desugar might not be in the base library of the bootstrapping compiler
import GHC.Desugar      ( AnnotationWrapper(..) )
import Unsafe.Coerce    ( unsafeCoerce )
#endif

import Control.Monad
import Control.Exception
import Data.Binary
import Data.Binary.Get
import Data.List        ( find )
import Data.Maybe
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as LB
import Data.Dynamic  ( fromDynamic, toDyn )
import qualified Data.IntMap as IntMap
import qualified Data.Map as Map
import Data.Typeable ( typeOf, Typeable, TypeRep, typeRep )
import Data.Data (Data)
import Data.Proxy    ( Proxy (..) )

{-
************************************************************************
*                                                                      *
\subsection{Main interface + stubs for the non-GHCI case
*                                                                      *
************************************************************************
-}

tcTypedBracket   :: HsExpr GhcRn -> HsBracket GhcRn -> ExpRhoType -> TcM (HsExpr GhcTc)
tcUntypedBracket :: HsExpr GhcRn -> HsBracket GhcRn -> [PendingRnSplice] -> ExpRhoType
                 -> TcM (HsExpr GhcTc)
tcSpliceExpr     :: HsSplice GhcRn  -> ExpRhoType -> TcM (HsExpr GhcTc)
        -- None of these functions add constraints to the LIE

-- runQuasiQuoteExpr :: HsQuasiQuote RdrName -> RnM (LHsExpr RdrName)
-- runQuasiQuotePat  :: HsQuasiQuote RdrName -> RnM (LPat RdrName)
-- runQuasiQuoteType :: HsQuasiQuote RdrName -> RnM (LHsType RdrName)
-- runQuasiQuoteDecl :: HsQuasiQuote RdrName -> RnM [LHsDecl RdrName]

runAnnotation     :: CoreAnnTarget -> LHsExpr GhcRn -> TcM Annotation
{-
************************************************************************
*                                                                      *
\subsection{Quoting an expression}
*                                                                      *
************************************************************************
-}

-- See Note [How brackets and nested splices are handled]
-- tcTypedBracket :: HsBracket Name -> TcRhoType -> TcM (HsExpr TcId)
tcTypedBracket :: HsExpr GhcRn -> HsBracket GhcRn -> ExpRhoType -> TcM (HsExpr GhcTc)
tcTypedBracket HsExpr GhcRn
rn_expr brack :: HsBracket GhcRn
brack@(TExpBr XTExpBr GhcRn
_ LHsExpr GhcRn
expr) ExpRhoType
res_ty
  = forall a. SDoc -> TcM a -> TcM a
addErrCtxt (HsBracket GhcRn -> SDoc
quotationCtxtDoc HsBracket GhcRn
brack) forall a b. (a -> b) -> a -> b
$
    do { ThStage
cur_stage <- TcM ThStage
getStage
       ; IORef [PendingTcSplice]
ps_ref <- forall a env. a -> IOEnv env (IORef a)
newMutVar []
       ; TcRef WantedConstraints
lie_var <- TcM (TcRef WantedConstraints)
getConstraintVar   -- Any constraints arising from nested splices
                                       -- should get thrown into the constraint set
                                       -- from outside the bracket

       -- Make a new type variable for the type of the overall quote
       ; Type
m_var <- Id -> Type
mkTyVarTy forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> TcM Id
mkMetaTyVar
       -- Make sure the type variable satisfies Quote
       ; Id
ev_var <- Type -> TcM Id
emitQuoteWanted Type
m_var
       -- Bundle them together so they can be used in GHC.HsToCore.Quote for desugaring
       -- brackets.
       ; let wrapper :: QuoteWrapper
wrapper = Id -> Type -> QuoteWrapper
QuoteWrapper Id
ev_var Type
m_var
       -- Typecheck expr to make sure it is valid,
       -- Throw away the typechecked expression but return its type.
       -- We'll typecheck it again when we splice it in somewhere
       ; (GenLocated SrcSpanAnnA (HsExpr GhcTc)
_tc_expr, Type
expr_ty) <- forall a. ThStage -> TcM a -> TcM a
setStage (ThStage -> PendingStuff -> ThStage
Brack ThStage
cur_stage (IORef [PendingTcSplice]
-> TcRef WantedConstraints -> QuoteWrapper -> PendingStuff
TcPending IORef [PendingTcSplice]
ps_ref TcRef WantedConstraints
lie_var QuoteWrapper
wrapper)) forall a b. (a -> b) -> a -> b
$
                                forall a. Type -> TcM a -> TcM a
tcScalingUsage Type
Many forall a b. (a -> b) -> a -> b
$
                                -- Scale by Many, TH lifting is currently nonlinear (#18465)
                                LHsExpr GhcRn -> TcM (LHsExpr GhcTc, Type)
tcInferRhoNC LHsExpr GhcRn
expr
                                -- NC for no context; tcBracket does that
       ; let rep :: Type
rep = HasDebugCallStack => Type -> Type
getRuntimeRep Type
expr_ty
       ; Type
meta_ty <- Type -> Type -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcTExpTy Type
m_var Type
expr_ty
       ; [PendingTcSplice]
ps' <- forall a env. IORef a -> IOEnv env a
readMutVar IORef [PendingTcSplice]
ps_ref
       ; Id
texpco <- Name -> TcM Id
tcLookupId Name
unsafeCodeCoerceName
       ; CtOrigin
-> HsExpr GhcRn
-> HsExpr GhcTc
-> Type
-> ExpRhoType
-> TcM (HsExpr GhcTc)
tcWrapResultO (String -> CtOrigin
Shouldn'tHappenOrigin String
"TExpBr")
                       HsExpr GhcRn
rn_expr
                       (forall l e. GenLocated l e -> e
unLoc (forall (id :: Pass).
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
mkHsApp (HsWrapper -> LHsExpr GhcTc -> LHsExpr GhcTc
mkLHsWrap (QuoteWrapper -> HsWrapper
applyQuoteWrapper QuoteWrapper
wrapper)
                                                  (Id -> [Type] -> LHsExpr GhcTc
nlHsTyApp Id
texpco [Type
rep, Type
expr_ty]))
                                      (forall a an. a -> LocatedAn an a
noLocA (forall p.
XTcBracketOut p
-> Maybe QuoteWrapper
-> HsBracket (HsBracketRn p)
-> [PendingTcSplice' p]
-> HsExpr p
HsTcBracketOut NoExtField
noExtField (forall a. a -> Maybe a
Just QuoteWrapper
wrapper) HsBracket GhcRn
brack [PendingTcSplice]
ps'))))
                       Type
meta_ty ExpRhoType
res_ty }
tcTypedBracket HsExpr GhcRn
_ HsBracket GhcRn
other_brack ExpRhoType
_
  = forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"tcTypedBracket" (forall a. Outputable a => a -> SDoc
ppr HsBracket GhcRn
other_brack)

-- tcUntypedBracket :: HsBracket Name -> [PendingRnSplice] -> ExpRhoType -> TcM (HsExpr TcId)
-- See Note [Typechecking Overloaded Quotes]
tcUntypedBracket :: HsExpr GhcRn
-> HsBracket GhcRn
-> [PendingRnSplice]
-> ExpRhoType
-> TcM (HsExpr GhcTc)
tcUntypedBracket HsExpr GhcRn
rn_expr HsBracket GhcRn
brack [PendingRnSplice]
ps ExpRhoType
res_ty
  = do { String -> SDoc -> TcRn ()
traceTc String
"tc_bracket untyped" (forall a. Outputable a => a -> SDoc
ppr HsBracket GhcRn
brack SDoc -> SDoc -> SDoc
$$ forall a. Outputable a => a -> SDoc
ppr [PendingRnSplice]
ps)


       -- Create the type m Exp for expression bracket, m Type for a type
       -- bracket and so on. The brack_info is a Maybe because the
       -- VarBracket ('a) isn't overloaded, but also shouldn't contain any
       -- splices.
       ; (Maybe QuoteWrapper
brack_info, Type
expected_type) <- HsBracket GhcRn -> TcM (Maybe QuoteWrapper, Type)
brackTy HsBracket GhcRn
brack

       -- Match the expected type with the type of all the internal
       -- splices. They might have further constrained types and if they do
       -- we want to reflect that in the overall type of the bracket.
       ; [PendingTcSplice]
ps' <- case QuoteWrapper -> Type
quoteWrapperTyVarTy forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Maybe QuoteWrapper
brack_info of
                  Just Type
m_var -> forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (Type -> PendingRnSplice -> TcM PendingTcSplice
tcPendingSplice Type
m_var) [PendingRnSplice]
ps
                  DFunInstType
Nothing -> ASSERT(null ps) return []

       ; String -> SDoc -> TcRn ()
traceTc String
"tc_bracket done untyped" (forall a. Outputable a => a -> SDoc
ppr Type
expected_type)

       -- Unify the overall type of the bracket with the expected result
       -- type
       ; CtOrigin
-> HsExpr GhcRn
-> HsExpr GhcTc
-> Type
-> ExpRhoType
-> TcM (HsExpr GhcTc)
tcWrapResultO CtOrigin
BracketOrigin HsExpr GhcRn
rn_expr
            (forall p.
XTcBracketOut p
-> Maybe QuoteWrapper
-> HsBracket (HsBracketRn p)
-> [PendingTcSplice' p]
-> HsExpr p
HsTcBracketOut NoExtField
noExtField Maybe QuoteWrapper
brack_info HsBracket GhcRn
brack [PendingTcSplice]
ps')
            Type
expected_type ExpRhoType
res_ty

       }

-- | A type variable with kind * -> * named "m"
mkMetaTyVar :: TcM TyVar
mkMetaTyVar :: TcM Id
mkMetaTyVar =
  FastString -> Type -> TcM Id
newNamedFlexiTyVar (String -> FastString
fsLit String
"m") (Type -> Type -> Type
mkVisFunTyMany Type
liftedTypeKind Type
liftedTypeKind)


-- | For a type 'm', emit the constraint 'Quote m'.
emitQuoteWanted :: Type -> TcM EvVar
emitQuoteWanted :: Type -> TcM Id
emitQuoteWanted Type
m_var =  do
        TyCon
quote_con <- Name -> TcM TyCon
tcLookupTyCon Name
quoteClassName
        CtOrigin -> Type -> TcM Id
emitWantedEvVar CtOrigin
BracketOrigin forall a b. (a -> b) -> a -> b
$
          TyCon -> [Type] -> Type
mkTyConApp TyCon
quote_con [Type
m_var]

---------------
-- | Compute the expected type of a quotation, and also the QuoteWrapper in
-- the case where it is an overloaded quotation. All quotation forms are
-- overloaded aprt from Variable quotations ('foo)
brackTy :: HsBracket GhcRn -> TcM (Maybe QuoteWrapper, Type)
brackTy :: HsBracket GhcRn -> TcM (Maybe QuoteWrapper, Type)
brackTy HsBracket GhcRn
b =
  let mkTy :: Name -> TcM (Maybe QuoteWrapper, Type)
mkTy Name
n = do
        -- New polymorphic type variable for the bracket
        Type
m_var <- Id -> Type
mkTyVarTy forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> TcM Id
mkMetaTyVar
        -- Emit a Quote constraint for the bracket
        Id
ev_var <- Type -> TcM Id
emitQuoteWanted Type
m_var
        -- Construct the final expected type of the quote, for example
        -- m Exp or m Type
        Type
final_ty <- Type -> Type -> Type
mkAppTy Type
m_var forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Name -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcMetaTy Name
n
        -- Return the evidence variable and metavariable to be used during
        -- desugaring.
        let wrapper :: QuoteWrapper
wrapper = Id -> Type -> QuoteWrapper
QuoteWrapper Id
ev_var Type
m_var
        forall (m :: * -> *) a. Monad m => a -> m a
return (forall a. a -> Maybe a
Just QuoteWrapper
wrapper, Type
final_ty)
  in
  case HsBracket GhcRn
b of
    (VarBr {}) -> (forall a. Maybe a
Nothing,) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Name -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcMetaTy Name
nameTyConName
                                           -- Result type is Var (not Quote-monadic)
    (ExpBr {})  -> Name -> TcM (Maybe QuoteWrapper, Type)
mkTy Name
expTyConName  -- Result type is m Exp
    (TypBr {})  -> Name -> TcM (Maybe QuoteWrapper, Type)
mkTy Name
typeTyConName -- Result type is m Type
    (DecBrG {}) -> Name -> TcM (Maybe QuoteWrapper, Type)
mkTy Name
decsTyConName -- Result type is m [Dec]
    (PatBr {})  -> Name -> TcM (Maybe QuoteWrapper, Type)
mkTy Name
patTyConName  -- Result type is m Pat
    (DecBrL {}) -> forall a. String -> a
panic String
"tcBrackTy: Unexpected DecBrL"
    (TExpBr {}) -> forall a. String -> a
panic String
"tcUntypedBracket: Unexpected TExpBr"

---------------
-- | Typechecking a pending splice from a untyped bracket
tcPendingSplice :: TcType -- Metavariable for the expected overall type of the
                          -- quotation.
                -> PendingRnSplice
                -> TcM PendingTcSplice
tcPendingSplice :: Type -> PendingRnSplice -> TcM PendingTcSplice
tcPendingSplice Type
m_var (PendingRnSplice UntypedSpliceFlavour
flavour Name
splice_name LHsExpr GhcRn
expr)
  -- See Note [Typechecking Overloaded Quotes]
  = do { Type
meta_ty <- Name -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcMetaTy Name
meta_ty_name
         -- Expected type of splice, e.g. m Exp
       ; let expected_type :: Type
expected_type = Type -> Type -> Type
mkAppTy Type
m_var Type
meta_ty
       ; GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr' <- forall a. Type -> TcM a -> TcM a
tcScalingUsage Type
Many forall a b. (a -> b) -> a -> b
$ LHsExpr GhcRn -> Type -> TcM (LHsExpr GhcTc)
tcCheckPolyExpr LHsExpr GhcRn
expr Type
expected_type
                  -- Scale by Many, TH lifting is currently nonlinear (#18465)
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> LHsExpr GhcTc -> PendingTcSplice
PendingTcSplice Name
splice_name GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr') }
  where
     meta_ty_name :: Name
meta_ty_name = case UntypedSpliceFlavour
flavour of
                       UntypedSpliceFlavour
UntypedExpSplice  -> Name
expTyConName
                       UntypedSpliceFlavour
UntypedPatSplice  -> Name
patTyConName
                       UntypedSpliceFlavour
UntypedTypeSplice -> Name
typeTyConName
                       UntypedSpliceFlavour
UntypedDeclSplice -> Name
decsTyConName

---------------
-- Takes a m and tau and returns the type m (TExp tau)
tcTExpTy :: TcType -> TcType -> TcM TcType
tcTExpTy :: Type -> Type -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcTExpTy Type
m_ty Type
exp_ty
  = do { forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (Type -> Bool
isTauTy Type
exp_ty) forall a b. (a -> b) -> a -> b
$ SDoc -> TcRn ()
addErr (forall a. Outputable a => a -> SDoc
err_msg Type
exp_ty)
       ; TyCon
codeCon <- Name -> TcM TyCon
tcLookupTyCon Name
codeTyConName
       ; let rep :: Type
rep = HasDebugCallStack => Type -> Type
getRuntimeRep Type
exp_ty
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (TyCon -> [Type] -> Type
mkTyConApp TyCon
codeCon [Type
rep, Type
m_ty, Type
exp_ty]) }
  where
    err_msg :: a -> SDoc
err_msg a
ty
      = [SDoc] -> SDoc
vcat [ String -> SDoc
text String
"Illegal polytype:" SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr a
ty
             , String -> SDoc
text String
"The type of a Typed Template Haskell expression must" SDoc -> SDoc -> SDoc
<+>
               String -> SDoc
text String
"not have any quantification." ]

quotationCtxtDoc :: HsBracket GhcRn -> SDoc
quotationCtxtDoc :: HsBracket GhcRn -> SDoc
quotationCtxtDoc HsBracket GhcRn
br_body
  = SDoc -> SumArity -> SDoc -> SDoc
hang (String -> SDoc
text String
"In the Template Haskell quotation")
         SumArity
2 (forall a. Outputable a => a -> SDoc
ppr HsBracket GhcRn
br_body)


  -- The whole of the rest of the file is the else-branch (ie stage2 only)

{-
Note [How top-level splices are handled]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Top-level splices (those not inside a [| .. |] quotation bracket) are handled
very straightforwardly:

  1. tcTopSpliceExpr: typecheck the body e of the splice $(e)

  2. runMetaT: desugar, compile, run it, and convert result back to
     GHC.Hs syntax RdrName (of the appropriate flavour, eg HsType RdrName,
     HsExpr RdrName etc)

  3. treat the result as if that's what you saw in the first place
     e.g for HsType, rename and kind-check
         for HsExpr, rename and type-check

     (The last step is different for decls, because they can *only* be
      top-level: we return the result of step 2.)

Note [How brackets and nested splices are handled]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Nested splices (those inside a [| .. |] quotation bracket),
are treated quite differently.

Remember, there are two forms of bracket
         typed   [|| e ||]
   and untyped   [|  e  |]

The life cycle of a typed bracket:
   * Starts as HsBracket

   * When renaming:
        * Set the ThStage to (Brack s RnPendingTyped)
        * Rename the body
        * Result is still a HsBracket

   * When typechecking:
        * Set the ThStage to (Brack s (TcPending ps_var lie_var))
        * Typecheck the body, and throw away the elaborated result
        * Nested splices (which must be typed) are typechecked, and
          the results accumulated in ps_var; their constraints
          accumulate in lie_var
        * Result is a HsTcBracketOut rn_brack pending_splices
          where rn_brack is the incoming renamed bracket

The life cycle of a un-typed bracket:
   * Starts as HsBracket

   * When renaming:
        * Set the ThStage to (Brack s (RnPendingUntyped ps_var))
        * Rename the body
        * Nested splices (which must be untyped) are renamed, and the
          results accumulated in ps_var
        * Result is still (HsRnBracketOut rn_body pending_splices)

   * When typechecking a HsRnBracketOut
        * Typecheck the pending_splices individually
        * Ignore the body of the bracket; just check that the context
          expects a bracket of that type (e.g. a [p| pat |] bracket should
          be in a context needing a (Q Pat)
        * Result is a HsTcBracketOut rn_brack pending_splices
          where rn_brack is the incoming renamed bracket


In both cases, desugaring happens like this:
  * HsTcBracketOut is desugared by GHC.HsToCore.Quote.dsBracket.  It

      a) Extends the ds_meta environment with the PendingSplices
         attached to the bracket

      b) Converts the quoted (HsExpr Name) to a CoreExpr that, when
         run, will produce a suitable TH expression/type/decl.  This
         is why we leave the *renamed* expression attached to the bracket:
         the quoted expression should not be decorated with all the goop
         added by the type checker

  * Each splice carries a unique Name, called a "splice point", thus
    ${n}(e).  The name is initialised to an (Unqual "splice") when the
    splice is created; the renamer gives it a unique.

  * When GHC.HsToCore.Quote (used to desugar the body of the bracket) comes across
    a splice, it looks up the splice's Name, n, in the ds_meta envt,
    to find an (HsExpr Id) that should be substituted for the splice;
    it just desugars it to get a CoreExpr (GHC.HsToCore.Quote.repSplice).

Example:
    Source:       f = [| Just $(g 3) |]
      The [| |] part is a HsBracket

    Typechecked:  f = [| Just ${s7}(g 3) |]{s7 = g Int 3}
      The [| |] part is a HsBracketOut, containing *renamed*
        (not typechecked) expression
      The "s7" is the "splice point"; the (g Int 3) part
        is a typechecked expression

    Desugared:    f = do { s7 <- g Int 3
                         ; return (ConE "Data.Maybe.Just" s7) }


Note [Template Haskell state diagram]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here are the ThStages, s, their corresponding level numbers
(the result of (thLevel s)), and their state transitions.
The top level of the program is stage Comp:

     Start here
         |
         V
      -----------     $      ------------   $
      |  Comp   | ---------> |  Splice  | -----|
      |   1     |            |    0     | <----|
      -----------            ------------
        ^     |                ^      |
      $ |     | [||]         $ |      | [||]
        |     v                |      v
   --------------          ----------------
   | Brack Comp |          | Brack Splice |
   |     2      |          |      1       |
   --------------          ----------------

* Normal top-level declarations start in state Comp
       (which has level 1).
  Annotations start in state Splice, since they are
       treated very like a splice (only without a '$')

* Code compiled in state Splice (and only such code)
  will be *run at compile time*, with the result replacing
  the splice

* The original paper used level -1 instead of 0, etc.

* The original paper did not allow a splice within a
  splice, but there is no reason not to. This is the
  $ transition in the top right.

Note [Template Haskell levels]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Imported things are impLevel (= 0)

* However things at level 0 are not *necessarily* imported.
      eg  $( \b -> ... )   here b is bound at level 0

* In GHCi, variables bound by a previous command are treated
  as impLevel, because we have bytecode for them.

* Variables are bound at the "current level"

* The current level starts off at outerLevel (= 1)

* The level is decremented by splicing $(..)
               incremented by brackets [| |]
               incremented by name-quoting 'f

* When a variable is used, checkWellStaged compares
        bind:  binding level, and
        use:   current level at usage site

  Generally
        bind > use      Always error (bound later than used)
                        [| \x -> $(f x) |]

        bind = use      Always OK (bound same stage as used)
                        [| \x -> $(f [| x |]) |]

        bind < use      Inside brackets, it depends
                        Inside splice, OK
                        Inside neither, OK

  For (bind < use) inside brackets, there are three cases:
    - Imported things   OK      f = [| map |]
    - Top-level things  OK      g = [| f |]
    - Non-top-level     Only if there is a liftable instance
                                h = \(x:Int) -> [| x |]

  To track top-level-ness we use the ThBindEnv in TcLclEnv

  For example:
           f = ...
           g1 = $(map ...)         is OK
           g2 = $(f ...)           is not OK; because we haven't compiled f yet

Note [Typechecking Overloaded Quotes]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The main function for typechecking untyped quotations is `tcUntypedBracket`.

Consider an expression quote, `[| e |]`, its type is `forall m . Quote m => m Exp`.
When we typecheck it we therefore create a template of a metavariable `m` applied to `Exp` and
emit a constraint `Quote m`. All this is done in the `brackTy` function.
`brackTy` also selects the correct contents type for the quotation (Exp, Type, Decs etc).

The meta variable and the constraint evidence variable are
returned together in a `QuoteWrapper` and then passed along to two further places
during compilation:

1. Typechecking nested splices (immediately in tcPendingSplice)
2. Desugaring quotations (see GHC.HsToCore.Quote)

`tcPendingSplice` takes the `m` type variable as an argument and checks
each nested splice against this variable `m`. During this
process the variable `m` can either be fixed to a specific value or further constrained by the
nested splices.

Once we have checked all the nested splices, the quote type is checked against
the expected return type.

The process is very simple and like typechecking a list where the quotation is
like the container and the splices are the elements of the list which must have
a specific type.

After the typechecking process is completed, the evidence variable for `Quote m`
and the type `m` is stored in a `QuoteWrapper` which is passed through the pipeline
and used when desugaring quotations.

Typechecking typed quotations is a similar idea but the `QuoteWrapper` is stored
in the `PendingStuff` as the nested splices are gathered up in a different way
to untyped splices. Untyped splices are found in the renamer but typed splices are
not typechecked and extracted until during typechecking.

-}

-- | We only want to produce warnings for TH-splices if the user requests so.
-- See Note [Warnings for TH splices].
getThSpliceOrigin :: TcM Origin
getThSpliceOrigin :: TcM Origin
getThSpliceOrigin = do
  Bool
warn <- forall gbl lcl. GeneralFlag -> TcRnIf gbl lcl Bool
goptM GeneralFlag
Opt_EnableThSpliceWarnings
  if Bool
warn then forall (m :: * -> *) a. Monad m => a -> m a
return Origin
FromSource else forall (m :: * -> *) a. Monad m => a -> m a
return Origin
Generated

{- Note [Warnings for TH splices]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We only produce warnings for TH splices when the user requests so
(-fenable-th-splice-warnings). There are multiple reasons:

  * It's not clear that the user that compiles a splice is the author of the code
    that produces the warning. Think of the situation where they just splice in
    code from a third-party library that produces incomplete pattern matches.
    In this scenario, the user isn't even able to fix that warning.
  * Gathering information for producing the warnings (pattern-match check
    warnings in particular) is costly. There's no point in doing so if the user
    is not interested in those warnings.

That's why we store Origin flags in the Haskell AST. The functions from ThToHs
take such a flag and depending on whether TH splice warnings were enabled or
not, we pass FromSource (if the user requests warnings) or Generated
(otherwise). This is implemented in getThSpliceOrigin.

For correct pattern-match warnings it's crucial that we annotate the Origin
consistently (#17270). In the future we could offer the Origin as part of the
TH AST. That would enable us to give quotes from the current module get
FromSource origin, and/or third library authors to tag certain parts of
generated code as FromSource to enable warnings.
That effort is tracked in #14838.
-}

{-
************************************************************************
*                                                                      *
\subsection{Splicing an expression}
*                                                                      *
************************************************************************
-}

tcSpliceExpr :: HsSplice GhcRn -> ExpRhoType -> TcM (HsExpr GhcTc)
tcSpliceExpr splice :: HsSplice GhcRn
splice@(HsTypedSplice XTypedSplice GhcRn
_ SpliceDecoration
_ IdP GhcRn
name LHsExpr GhcRn
expr) ExpRhoType
res_ty
  = forall a. SDoc -> TcM a -> TcM a
addErrCtxt (HsSplice GhcRn -> SDoc
spliceCtxtDoc HsSplice GhcRn
splice) forall a b. (a -> b) -> a -> b
$
    forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan (forall a e. GenLocated (SrcSpanAnn' a) e -> SrcSpan
getLocA LHsExpr GhcRn
expr)    forall a b. (a -> b) -> a -> b
$ do
    { ThStage
stage <- TcM ThStage
getStage
    ; case ThStage
stage of
          Splice {}            -> LHsExpr GhcRn -> ExpRhoType -> TcM (HsExpr GhcTc)
tcTopSplice LHsExpr GhcRn
expr ExpRhoType
res_ty
          Brack ThStage
pop_stage PendingStuff
pend -> ThStage
-> PendingStuff
-> Name
-> LHsExpr GhcRn
-> ExpRhoType
-> TcM (HsExpr GhcTc)
tcNestedSplice ThStage
pop_stage PendingStuff
pend IdP GhcRn
name LHsExpr GhcRn
expr ExpRhoType
res_ty
          RunSplice TcRef [ForeignRef (Q ())]
_          ->
            -- See Note [RunSplice ThLevel] in "GHC.Tc.Types".
            forall a. HasCallStack => String -> SDoc -> a
pprPanic (String
"tcSpliceExpr: attempted to typecheck a splice when " forall a. [a] -> [a] -> [a]
++
                      String
"running another splice") (forall a. Outputable a => a -> SDoc
ppr HsSplice GhcRn
splice)
          ThStage
Comp                 -> LHsExpr GhcRn -> ExpRhoType -> TcM (HsExpr GhcTc)
tcTopSplice LHsExpr GhcRn
expr ExpRhoType
res_ty
    }
tcSpliceExpr HsSplice GhcRn
splice ExpRhoType
_
  = forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"tcSpliceExpr" (forall a. Outputable a => a -> SDoc
ppr HsSplice GhcRn
splice)

{- Note [Collecting modFinalizers in typed splices]
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

'qAddModFinalizer' of the @Quasi TcM@ instance adds finalizers in the local
environment (see Note [Delaying modFinalizers in untyped splices] in
GHC.Rename.Splice). Thus after executing the splice, we move the finalizers to the
finalizer list in the global environment and set them to use the current local
environment (with 'addModFinalizersWithLclEnv').

-}

tcNestedSplice :: ThStage -> PendingStuff -> Name
                -> LHsExpr GhcRn -> ExpRhoType -> TcM (HsExpr GhcTc)
    -- See Note [How brackets and nested splices are handled]
    -- A splice inside brackets
tcNestedSplice :: ThStage
-> PendingStuff
-> Name
-> LHsExpr GhcRn
-> ExpRhoType
-> TcM (HsExpr GhcTc)
tcNestedSplice ThStage
pop_stage (TcPending IORef [PendingTcSplice]
ps_var TcRef WantedConstraints
lie_var q :: QuoteWrapper
q@(QuoteWrapper Id
_ Type
m_var)) Name
splice_name LHsExpr GhcRn
expr ExpRhoType
res_ty
  = do { Type
res_ty <- ExpRhoType -> IOEnv (Env TcGblEnv TcLclEnv) Type
expTypeToType ExpRhoType
res_ty
       ; let rep :: Type
rep = HasDebugCallStack => Type -> Type
getRuntimeRep Type
res_ty
       ; Type
meta_exp_ty <- Type -> Type -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcTExpTy Type
m_var Type
res_ty
       ; GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr' <- forall a. ThStage -> TcM a -> TcM a
setStage ThStage
pop_stage forall a b. (a -> b) -> a -> b
$
                  forall a. TcRef WantedConstraints -> TcM a -> TcM a
setConstraintVar TcRef WantedConstraints
lie_var forall a b. (a -> b) -> a -> b
$
                  LHsExpr GhcRn -> Type -> TcM (LHsExpr GhcTc)
tcCheckMonoExpr LHsExpr GhcRn
expr Type
meta_exp_ty
       ; Id
untype_code <- Name -> TcM Id
tcLookupId Name
unTypeCodeName
       ; let expr'' :: LHsExpr GhcTc
expr'' = forall (id :: Pass).
LHsExpr (GhcPass id)
-> LHsExpr (GhcPass id) -> LHsExpr (GhcPass id)
mkHsApp
                        (HsWrapper -> LHsExpr GhcTc -> LHsExpr GhcTc
mkLHsWrap (QuoteWrapper -> HsWrapper
applyQuoteWrapper QuoteWrapper
q)
                          (Id -> [Type] -> LHsExpr GhcTc
nlHsTyApp Id
untype_code [Type
rep, Type
res_ty])) GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr'
       ; [PendingTcSplice]
ps <- forall a env. IORef a -> IOEnv env a
readMutVar IORef [PendingTcSplice]
ps_var
       ; forall a env. IORef a -> a -> IOEnv env ()
writeMutVar IORef [PendingTcSplice]
ps_var (Name -> LHsExpr GhcTc -> PendingTcSplice
PendingTcSplice Name
splice_name LHsExpr GhcTc
expr'' forall a. a -> [a] -> [a]
: [PendingTcSplice]
ps)

       -- The returned expression is ignored; it's in the pending splices
       -- But we still return a plausible expression
       --   (a) in case we print it in debug messages, and
       --   (b) because we test whether it is tagToEnum in Tc.Gen.Expr.tcApp
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (forall p. XSpliceE p -> HsSplice p -> HsExpr p
HsSpliceE forall a. EpAnn a
noAnn forall a b. (a -> b) -> a -> b
$
                 forall id.
XSpliced id -> ThModFinalizers -> HsSplicedThing id -> HsSplice id
HsSpliced NoExtField
noExtField ([ForeignRef (Q ())] -> ThModFinalizers
ThModFinalizers []) forall a b. (a -> b) -> a -> b
$
                 forall id. HsExpr id -> HsSplicedThing id
HsSplicedExpr (forall l e. GenLocated l e -> e
unLoc LHsExpr GhcTc
expr'')) }


tcNestedSplice ThStage
_ PendingStuff
_ Name
splice_name LHsExpr GhcRn
_ ExpRhoType
_
  = forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"tcNestedSplice: rename stage found" (forall a. Outputable a => a -> SDoc
ppr Name
splice_name)

tcTopSplice :: LHsExpr GhcRn -> ExpRhoType -> TcM (HsExpr GhcTc)
tcTopSplice :: LHsExpr GhcRn -> ExpRhoType -> TcM (HsExpr GhcTc)
tcTopSplice LHsExpr GhcRn
expr ExpRhoType
res_ty
  = do { -- Typecheck the expression,
         -- making sure it has type Q (T res_ty)
         Type
res_ty <- ExpRhoType -> IOEnv (Env TcGblEnv TcLclEnv) Type
expTypeToType ExpRhoType
res_ty
       ; Type
q_type <- Name -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcMetaTy Name
qTyConName
       -- Top level splices must still be of type Q (TExp a)
       ; Type
meta_exp_ty <- Type -> Type -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcTExpTy Type
q_type Type
res_ty
       ; GenLocated SrcSpanAnnA (HsExpr GhcTc)
q_expr <- SpliceType -> TcM (LHsExpr GhcTc) -> TcM (LHsExpr GhcTc)
tcTopSpliceExpr SpliceType
Typed forall a b. (a -> b) -> a -> b
$
                   LHsExpr GhcRn -> Type -> TcM (LHsExpr GhcTc)
tcCheckMonoExpr LHsExpr GhcRn
expr Type
meta_exp_ty
       ; TcLclEnv
lcl_env <- forall gbl lcl. TcRnIf gbl lcl lcl
getLclEnv
       ; let delayed_splice :: DelayedSplice
delayed_splice
              = TcLclEnv -> LHsExpr GhcRn -> Type -> LHsExpr GhcTc -> DelayedSplice
DelayedSplice TcLclEnv
lcl_env LHsExpr GhcRn
expr Type
res_ty GenLocated SrcSpanAnnA (HsExpr GhcTc)
q_expr
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (forall p. XSpliceE p -> HsSplice p -> HsExpr p
HsSpliceE forall a. EpAnn a
noAnn (forall id. XXSplice id -> HsSplice id
XSplice (DelayedSplice -> HsSplicedT
HsSplicedT DelayedSplice
delayed_splice)))

       }


-- This is called in the zonker
-- See Note [Running typed splices in the zonker]
runTopSplice :: DelayedSplice -> TcM (HsExpr GhcTc)
runTopSplice :: DelayedSplice -> TcM (HsExpr GhcTc)
runTopSplice (DelayedSplice TcLclEnv
lcl_env LHsExpr GhcRn
orig_expr Type
res_ty LHsExpr GhcTc
q_expr)
  = do
      TcRef (Messages DecoratedSDoc)
errs_var <- TcRn (TcRef (Messages DecoratedSDoc))
getErrsVar
      forall lcl' gbl a lcl.
lcl' -> TcRnIf gbl lcl' a -> TcRnIf gbl lcl a
setLclEnv TcLclEnv
lcl_env forall a b. (a -> b) -> a -> b
$ forall a. TcRef (Messages DecoratedSDoc) -> TcRn a -> TcRn a
setErrsVar TcRef (Messages DecoratedSDoc)
errs_var forall a b. (a -> b) -> a -> b
$ do {
         -- Set the errs_var to the errs_var from the current context,
         -- otherwise error messages can go missing in GHCi (#19470)
         Type
zonked_ty <- Type -> IOEnv (Env TcGblEnv TcLclEnv) Type
zonkTcType Type
res_ty
       ; GenLocated SrcSpanAnnA (HsExpr GhcTc)
zonked_q_expr <- LHsExpr GhcTc -> TcM (LHsExpr GhcTc)
zonkTopLExpr LHsExpr GhcTc
q_expr
        -- See Note [Collecting modFinalizers in typed splices].
       ; TcRef [ForeignRef (Q ())]
modfinalizers_ref <- forall a gbl lcl. a -> TcRnIf gbl lcl (TcRef a)
newTcRef []
         -- Run the expression
       ; GenLocated SrcSpanAnnA (HsExpr GhcPs)
expr2 <- forall a. ThStage -> TcM a -> TcM a
setStage (TcRef [ForeignRef (Q ())] -> ThStage
RunSplice TcRef [ForeignRef (Q ())]
modfinalizers_ref) forall a b. (a -> b) -> a -> b
$
                    LHsExpr GhcTc -> TcRn (LHsExpr GhcPs)
runMetaE GenLocated SrcSpanAnnA (HsExpr GhcTc)
zonked_q_expr
       ; [ForeignRef (Q ())]
mod_finalizers <- forall a gbl lcl. TcRef a -> TcRnIf gbl lcl a
readTcRef TcRef [ForeignRef (Q ())]
modfinalizers_ref
       ; ThModFinalizers -> TcRn ()
addModFinalizersWithLclEnv forall a b. (a -> b) -> a -> b
$ [ForeignRef (Q ())] -> ThModFinalizers
ThModFinalizers [ForeignRef (Q ())]
mod_finalizers
       -- We use orig_expr here and not q_expr when tracing as a call to
       -- unsafeTExpCoerce is added to the original expression by the
       -- typechecker when typed quotes are type checked.
       ; SpliceInfo -> TcRn ()
traceSplice (SpliceInfo { spliceDescription :: String
spliceDescription = String
"expression"
                                 , spliceIsDecl :: Bool
spliceIsDecl      = Bool
False
                                 , spliceSource :: Maybe (LHsExpr GhcRn)
spliceSource      = forall a. a -> Maybe a
Just LHsExpr GhcRn
orig_expr
                                 , spliceGenerated :: SDoc
spliceGenerated   = forall a. Outputable a => a -> SDoc
ppr GenLocated SrcSpanAnnA (HsExpr GhcPs)
expr2 })
        -- Rename and typecheck the spliced-in expression,
        -- making sure it has type res_ty
        -- These steps should never fail; this is a *typed* splice
       ; (GenLocated SrcSpanAnnA (HsExpr GhcTc)
res, WantedConstraints
wcs) <-
            forall a. TcM a -> TcM (a, WantedConstraints)
captureConstraints forall a b. (a -> b) -> a -> b
$
              forall a. SDoc -> TcM a -> TcM a
addErrCtxt (LHsExpr GhcTc -> SDoc
spliceResultDoc GenLocated SrcSpanAnnA (HsExpr GhcTc)
zonked_q_expr) forall a b. (a -> b) -> a -> b
$ do
                { (GenLocated SrcSpanAnnA (HsExpr GhcRn)
exp3, FreeVars
_fvs) <- LHsExpr GhcPs -> RnM (LHsExpr GhcRn, FreeVars)
rnLExpr GenLocated SrcSpanAnnA (HsExpr GhcPs)
expr2
                ; LHsExpr GhcRn -> Type -> TcM (LHsExpr GhcTc)
tcCheckMonoExpr GenLocated SrcSpanAnnA (HsExpr GhcRn)
exp3 Type
zonked_ty }
       ; Bag EvBind
ev <- WantedConstraints -> TcM (Bag EvBind)
simplifyTop WantedConstraints
wcs
       ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall l e. GenLocated l e -> e
unLoc (TcEvBinds -> LHsExpr GhcTc -> LHsExpr GhcTc
mkHsDictLet (Bag EvBind -> TcEvBinds
EvBinds Bag EvBind
ev) GenLocated SrcSpanAnnA (HsExpr GhcTc)
res)
       }


{-
************************************************************************
*                                                                      *
\subsection{Error messages}
*                                                                      *
************************************************************************
-}

spliceCtxtDoc :: HsSplice GhcRn -> SDoc
spliceCtxtDoc :: HsSplice GhcRn -> SDoc
spliceCtxtDoc HsSplice GhcRn
splice
  = SDoc -> SumArity -> SDoc -> SDoc
hang (String -> SDoc
text String
"In the Template Haskell splice")
         SumArity
2 (forall (p :: Pass).
OutputableBndrId p =>
HsSplice (GhcPass p) -> SDoc
pprSplice HsSplice GhcRn
splice)

spliceResultDoc :: LHsExpr GhcTc -> SDoc
spliceResultDoc :: LHsExpr GhcTc -> SDoc
spliceResultDoc LHsExpr GhcTc
expr
  = [SDoc] -> SDoc
sep [ String -> SDoc
text String
"In the result of the splice:"
        , SumArity -> SDoc -> SDoc
nest SumArity
2 (Char -> SDoc
char Char
'$' SDoc -> SDoc -> SDoc
<> forall a. Outputable a => a -> SDoc
ppr LHsExpr GhcTc
expr)
        , String -> SDoc
text String
"To see what the splice expanded to, use -ddump-splices"]

-------------------
tcTopSpliceExpr :: SpliceType -> TcM (LHsExpr GhcTc) -> TcM (LHsExpr GhcTc)
-- Note [How top-level splices are handled]
-- Type check an expression that is the body of a top-level splice
--   (the caller will compile and run it)
-- Note that set the level to Splice, regardless of the original level,
-- before typechecking the expression.  For example:
--      f x = $( ...$(g 3) ... )
-- The recursive call to tcCheckPolyExpr will simply expand the
-- inner escape before dealing with the outer one

tcTopSpliceExpr :: SpliceType -> TcM (LHsExpr GhcTc) -> TcM (LHsExpr GhcTc)
tcTopSpliceExpr SpliceType
isTypedSplice TcM (LHsExpr GhcTc)
tc_action
  = forall r. TcM r -> TcM r
checkNoErrs forall a b. (a -> b) -> a -> b
$  -- checkNoErrs: must not try to run the thing
                   -- if the type checker fails!
    forall gbl lcl a.
GeneralFlag -> TcRnIf gbl lcl a -> TcRnIf gbl lcl a
unsetGOptM GeneralFlag
Opt_DeferTypeErrors forall a b. (a -> b) -> a -> b
$
                   -- Don't defer type errors.  Not only are we
                   -- going to run this code, but we do an unsafe
                   -- coerce, so we get a seg-fault if, say we
                   -- splice a type into a place where an expression
                   -- is expected (#7276)
    forall a. ThStage -> TcM a -> TcM a
setStage (SpliceType -> ThStage
Splice SpliceType
isTypedSplice) forall a b. (a -> b) -> a -> b
$
    do {    -- Typecheck the expression
         (Maybe (GenLocated SrcSpanAnnA (HsExpr GhcTc))
mb_expr', WantedConstraints
wanted) <- forall a. TcM a -> TcM (Maybe a, WantedConstraints)
tryCaptureConstraints TcM (LHsExpr GhcTc)
tc_action
             -- If tc_action fails (perhaps because of insoluble constraints)
             -- we want to capture and report those constraints, else we may
             -- just get a silent failure (#20179). Hence the 'try' part.

       ; Bag EvBind
const_binds <- WantedConstraints -> TcM (Bag EvBind)
simplifyTop WantedConstraints
wanted

       ; case Maybe (GenLocated SrcSpanAnnA (HsExpr GhcTc))
mb_expr' of
            Maybe (GenLocated SrcSpanAnnA (HsExpr GhcTc))
Nothing    -> forall env a. IOEnv env a
failM   -- In this case simplifyTop should have
                                  -- reported some errors
            Just GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr' -> forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ TcEvBinds -> LHsExpr GhcTc -> LHsExpr GhcTc
mkHsDictLet (Bag EvBind -> TcEvBinds
EvBinds Bag EvBind
const_binds) GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr' }

{-
************************************************************************
*                                                                      *
        Annotations
*                                                                      *
************************************************************************
-}

runAnnotation :: CoreAnnTarget -> LHsExpr GhcRn -> TcM Annotation
runAnnotation CoreAnnTarget
target LHsExpr GhcRn
expr = do
    -- Find the classes we want instances for in order to call toAnnotationWrapper
    SrcSpan
loc <- TcRn SrcSpan
getSrcSpanM
    Class
data_class <- Name -> TcM Class
tcLookupClass Name
dataClassName
    Id
to_annotation_wrapper_id <- Name -> TcM Id
tcLookupId Name
toAnnotationWrapperName

    -- Check the instances we require live in another module (we want to execute it..)
    -- and check identifiers live in other modules using TH stage checks. tcSimplifyStagedExpr
    -- also resolves the LIE constraints to detect e.g. instance ambiguity
    GenLocated SrcSpanAnnA (HsExpr GhcTc)
zonked_wrapped_expr' <- LHsExpr GhcTc -> TcM (LHsExpr GhcTc)
zonkTopLExpr forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< SpliceType -> TcM (LHsExpr GhcTc) -> TcM (LHsExpr GhcTc)
tcTopSpliceExpr SpliceType
Untyped (
           do { (GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr', Type
expr_ty) <- LHsExpr GhcRn -> TcM (LHsExpr GhcTc, Type)
tcInferRhoNC LHsExpr GhcRn
expr
                -- We manually wrap the typechecked expression in a call to toAnnotationWrapper
                -- By instantiating the call >here< it gets registered in the
                -- LIE consulted by tcTopSpliceExpr
                -- and hence ensures the appropriate dictionary is bound by const_binds
              ; HsWrapper
wrapper <- CtOrigin -> [Type] -> [Type] -> TcM HsWrapper
instCall CtOrigin
AnnOrigin [Type
expr_ty] [Class -> [Type] -> Type
mkClassPred Class
data_class [Type
expr_ty]]
              ; let loc' :: SrcSpanAnnA
loc' = forall ann. SrcSpan -> SrcAnn ann
noAnnSrcSpan SrcSpan
loc
              ; let specialised_to_annotation_wrapper_expr :: GenLocated SrcSpanAnnA (HsExpr GhcTc)
specialised_to_annotation_wrapper_expr
                      = forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc' (HsWrapper -> HsExpr GhcTc -> HsExpr GhcTc
mkHsWrap HsWrapper
wrapper
                                 (forall p. XVar p -> LIdP p -> HsExpr p
HsVar NoExtField
noExtField (forall l e. l -> e -> GenLocated l e
L (forall ann. SrcSpan -> SrcAnn ann
noAnnSrcSpan SrcSpan
loc) Id
to_annotation_wrapper_id)))
              ; forall (m :: * -> *) a. Monad m => a -> m a
return (forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
loc' (forall p. XApp p -> LHsExpr p -> LHsExpr p -> HsExpr p
HsApp EpAnnCO
noComments
                                GenLocated SrcSpanAnnA (HsExpr GhcTc)
specialised_to_annotation_wrapper_expr GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr'))
                                })

    -- Run the appropriately wrapped expression to get the value of
    -- the annotation and its dictionaries. The return value is of
    -- type AnnotationWrapper by construction, so this conversion is
    -- safe
    Serialized
serialized <- LHsExpr GhcTc -> TcM Serialized
runMetaAW GenLocated SrcSpanAnnA (HsExpr GhcTc)
zonked_wrapped_expr'
    forall (m :: * -> *) a. Monad m => a -> m a
return Annotation {
               ann_target :: CoreAnnTarget
ann_target = CoreAnnTarget
target,
               ann_value :: Serialized
ann_value = Serialized
serialized
           }

convertAnnotationWrapper :: ForeignHValue -> TcM (Either SDoc Serialized)
convertAnnotationWrapper :: ForeignHValue -> TcM (Either SDoc Serialized)
convertAnnotationWrapper ForeignHValue
fhv = do
  Interp
interp <- TcM Interp
tcGetInterp
  case Interp -> InterpInstance
interpInstance Interp
interp of
    ExternalInterp {} -> forall a b. b -> Either a b
Right forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall a. Binary a => THResultType -> ForeignHValue -> TcM a
runTH THResultType
THAnnWrapper ForeignHValue
fhv
#if defined(HAVE_INTERNAL_INTERPRETER)
    InterpInstance
InternalInterp    -> do
      HValue
annotation_wrapper <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall a. Interp -> ForeignRef a -> IO a
wormhole Interp
interp ForeignHValue
fhv
      forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a b. b -> Either a b
Right forall a b. (a -> b) -> a -> b
$
        case forall a b. a -> b
unsafeCoerce HValue
annotation_wrapper of
           AnnotationWrapper a
value | let serialized :: Serialized
serialized = forall a. Typeable a => (a -> [Word8]) -> a -> Serialized
toSerialized forall a. Data a => a -> [Word8]
serializeWithData a
value ->
               -- Got the value and dictionaries: build the serialized value and
               -- call it a day. We ensure that we seq the entire serialized value
               -- in order that any errors in the user-written code for the
               -- annotation are exposed at this point.  This is also why we are
               -- doing all this stuff inside the context of runMeta: it has the
               -- facilities to deal with user error in a meta-level expression
               Serialized -> ()
seqSerialized Serialized
serialized seq :: forall a b. a -> b -> b
`seq` Serialized
serialized

-- | Force the contents of the Serialized value so weknow it doesn't contain any bottoms
seqSerialized :: Serialized -> ()
seqSerialized :: Serialized -> ()
seqSerialized (Serialized TypeRep
the_type [Word8]
bytes) = TypeRep
the_type seq :: forall a b. a -> b -> b
`seq` [Word8]
bytes forall a b. [a] -> b -> b
`seqList` ()

#endif

{-
************************************************************************
*                                                                      *
\subsection{Running an expression}
*                                                                      *
************************************************************************
-}

runQuasi :: TH.Q a -> TcM a
runQuasi :: forall a. Q a -> TcM a
runQuasi Q a
act = forall (m :: * -> *) a. Quasi m => Q a -> m a
TH.runQ Q a
act

runRemoteModFinalizers :: ThModFinalizers -> TcM ()
runRemoteModFinalizers :: ThModFinalizers -> TcRn ()
runRemoteModFinalizers (ThModFinalizers [ForeignRef (Q ())]
finRefs) = do
  let withForeignRefs :: [ForeignRef a] -> ([RemoteRef a] -> IO b) -> IO b
withForeignRefs [] [RemoteRef a] -> IO b
f = [RemoteRef a] -> IO b
f []
      withForeignRefs (ForeignRef a
x : [ForeignRef a]
xs) [RemoteRef a] -> IO b
f = forall a b. ForeignRef a -> (RemoteRef a -> IO b) -> IO b
withForeignRef ForeignRef a
x forall a b. (a -> b) -> a -> b
$ \RemoteRef a
r ->
        [ForeignRef a] -> ([RemoteRef a] -> IO b) -> IO b
withForeignRefs [ForeignRef a]
xs forall a b. (a -> b) -> a -> b
$ \[RemoteRef a]
rs -> [RemoteRef a] -> IO b
f (RemoteRef a
r forall a. a -> [a] -> [a]
: [RemoteRef a]
rs)
  Interp
interp <- TcM Interp
tcGetInterp
  case Interp -> InterpInstance
interpInstance Interp
interp of
#if defined(HAVE_INTERNAL_INTERPRETER)
    InterpInstance
InternalInterp -> do
      [Q ()]
qs <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (forall {a} {b}. [ForeignRef a] -> ([RemoteRef a] -> IO b) -> IO b
withForeignRefs [ForeignRef (Q ())]
finRefs forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM forall a. RemoteRef a -> IO a
localRef)
      forall a. Q a -> TcM a
runQuasi forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) (m :: * -> *) a.
(Foldable t, Monad m) =>
t (m a) -> m ()
sequence_ [Q ()]
qs
#endif

    ExternalInterp IServConfig
conf IServ
iserv -> forall (m :: * -> *) a.
(MonadIO m, ExceptionMonad m) =>
IServConfig -> IServ -> (IServInstance -> m a) -> m a
withIServ_ IServConfig
conf IServ
iserv forall a b. (a -> b) -> a -> b
$ \IServInstance
i -> do
      TcGblEnv
tcg <- forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
      Maybe (ForeignRef (IORef QState))
th_state <- forall a gbl lcl. TcRef a -> TcRnIf gbl lcl a
readTcRef (TcGblEnv -> TcRef (Maybe (ForeignRef (IORef QState)))
tcg_th_remote_state TcGblEnv
tcg)
      case Maybe (ForeignRef (IORef QState))
th_state of
        Maybe (ForeignRef (IORef QState))
Nothing -> forall (m :: * -> *) a. Monad m => a -> m a
return () -- TH was not started, nothing to do
        Just ForeignRef (IORef QState)
fhv -> do
          forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall a b. ForeignRef a -> (RemoteRef a -> IO b) -> IO b
withForeignRef ForeignRef (IORef QState)
fhv forall a b. (a -> b) -> a -> b
$ \RemoteRef (IORef QState)
st ->
            forall {a} {b}. [ForeignRef a] -> ([RemoteRef a] -> IO b) -> IO b
withForeignRefs [ForeignRef (Q ())]
finRefs forall a b. (a -> b) -> a -> b
$ \[RemoteRef (Q ())]
qrefs ->
              IServInstance -> Put -> IO ()
writeIServ IServInstance
i (forall a. Message a -> Put
putMessage (RemoteRef (IORef QState)
-> [RemoteRef (Q ())] -> Message (QResult ())
RunModFinalizers RemoteRef (IORef QState)
st [RemoteRef (Q ())]
qrefs))
          () <- IServInstance -> [Messages DecoratedSDoc] -> TcRn ()
runRemoteTH IServInstance
i []
          forall a. Binary a => IServInstance -> TcM a
readQResult IServInstance
i

runQResult
  :: (a -> String)
  -> (Origin -> SrcSpan -> a -> b)
  -> (ForeignHValue -> TcM a)
  -> SrcSpan
  -> ForeignHValue {- TH.Q a -}
  -> TcM b
runQResult :: forall a b.
(a -> String)
-> (Origin -> SrcSpan -> a -> b)
-> (ForeignHValue -> TcM a)
-> SrcSpan
-> ForeignHValue
-> TcM b
runQResult a -> String
show_th Origin -> SrcSpan -> a -> b
f ForeignHValue -> TcM a
runQ SrcSpan
expr_span ForeignHValue
hval
  = do { a
th_result <- ForeignHValue -> TcM a
runQ ForeignHValue
hval
       ; Origin
th_origin <- TcM Origin
getThSpliceOrigin
       ; String -> SDoc -> TcRn ()
traceTc String
"Got TH result:" (String -> SDoc
text (a -> String
show_th a
th_result))
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (Origin -> SrcSpan -> a -> b
f Origin
th_origin SrcSpan
expr_span a
th_result) }


-----------------
runMeta :: (MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn)
        -> LHsExpr GhcTc
        -> TcM hs_syn
runMeta :: forall hs_syn.
(MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn)
-> LHsExpr GhcTc -> TcM hs_syn
runMeta MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn
unwrap LHsExpr GhcTc
e = do
    Hooks
hooks <- forall (m :: * -> *). HasHooks m => m Hooks
getHooks
    case Hooks -> Maybe (MetaHook TcM)
runMetaHook Hooks
hooks of
        Maybe (MetaHook TcM)
Nothing -> MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn
unwrap MetaHook TcM
defaultRunMeta LHsExpr GhcTc
e
        Just MetaHook TcM
h  -> MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn
unwrap MetaHook TcM
h LHsExpr GhcTc
e

defaultRunMeta :: MetaHook TcM
defaultRunMeta :: MetaHook TcM
defaultRunMeta (MetaE LHsExpr GhcPs -> MetaResult
r)
  = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap LHsExpr GhcPs -> MetaResult
r forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall hs_syn.
Bool
-> (hs_syn -> SDoc)
-> (SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn))
-> LHsExpr GhcTc
-> TcM hs_syn
runMeta' Bool
True forall a. Outputable a => a -> SDoc
ppr (forall a b.
(a -> String)
-> (Origin -> SrcSpan -> a -> b)
-> (ForeignHValue -> TcM a)
-> SrcSpan
-> ForeignHValue
-> TcM b
runQResult forall a. Ppr a => a -> String
TH.pprint Origin -> SrcSpan -> Exp -> Either SDoc (LHsExpr GhcPs)
convertToHsExpr ForeignHValue -> TcM Exp
runTHExp)
defaultRunMeta (MetaP LPat GhcPs -> MetaResult
r)
  = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap LPat GhcPs -> MetaResult
r forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall hs_syn.
Bool
-> (hs_syn -> SDoc)
-> (SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn))
-> LHsExpr GhcTc
-> TcM hs_syn
runMeta' Bool
True forall a. Outputable a => a -> SDoc
ppr (forall a b.
(a -> String)
-> (Origin -> SrcSpan -> a -> b)
-> (ForeignHValue -> TcM a)
-> SrcSpan
-> ForeignHValue
-> TcM b
runQResult forall a. Ppr a => a -> String
TH.pprint Origin -> SrcSpan -> Pat -> Either SDoc (LPat GhcPs)
convertToPat ForeignHValue -> TcM Pat
runTHPat)
defaultRunMeta (MetaT LHsType GhcPs -> MetaResult
r)
  = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap LHsType GhcPs -> MetaResult
r forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall hs_syn.
Bool
-> (hs_syn -> SDoc)
-> (SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn))
-> LHsExpr GhcTc
-> TcM hs_syn
runMeta' Bool
True forall a. Outputable a => a -> SDoc
ppr (forall a b.
(a -> String)
-> (Origin -> SrcSpan -> a -> b)
-> (ForeignHValue -> TcM a)
-> SrcSpan
-> ForeignHValue
-> TcM b
runQResult forall a. Ppr a => a -> String
TH.pprint Origin -> SrcSpan -> Type -> Either SDoc (LHsType GhcPs)
convertToHsType ForeignHValue -> TcM Type
runTHType)
defaultRunMeta (MetaD [LHsDecl GhcPs] -> MetaResult
r)
  = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap [LHsDecl GhcPs] -> MetaResult
r forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall hs_syn.
Bool
-> (hs_syn -> SDoc)
-> (SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn))
-> LHsExpr GhcTc
-> TcM hs_syn
runMeta' Bool
True forall a. Outputable a => a -> SDoc
ppr (forall a b.
(a -> String)
-> (Origin -> SrcSpan -> a -> b)
-> (ForeignHValue -> TcM a)
-> SrcSpan
-> ForeignHValue
-> TcM b
runQResult forall a. Ppr a => a -> String
TH.pprint Origin -> SrcSpan -> [Dec] -> Either SDoc [LHsDecl GhcPs]
convertToHsDecls ForeignHValue -> TcM [Dec]
runTHDec)
defaultRunMeta (MetaAW Serialized -> MetaResult
r)
  = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Serialized -> MetaResult
r forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall hs_syn.
Bool
-> (hs_syn -> SDoc)
-> (SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn))
-> LHsExpr GhcTc
-> TcM hs_syn
runMeta' Bool
False (forall a b. a -> b -> a
const SDoc
empty) (forall a b. a -> b -> a
const ForeignHValue -> TcM (Either SDoc Serialized)
convertAnnotationWrapper)
    -- We turn off showing the code in meta-level exceptions because doing so exposes
    -- the toAnnotationWrapper function that we slap around the user's code

----------------
runMetaAW :: LHsExpr GhcTc         -- Of type AnnotationWrapper
          -> TcM Serialized
runMetaAW :: LHsExpr GhcTc -> TcM Serialized
runMetaAW = forall hs_syn.
(MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn)
-> LHsExpr GhcTc -> TcM hs_syn
runMeta forall (f :: * -> *).
Functor f =>
MetaHook f -> LHsExpr GhcTc -> f Serialized
metaRequestAW

runMetaE :: LHsExpr GhcTc          -- Of type (Q Exp)
         -> TcM (LHsExpr GhcPs)
runMetaE :: LHsExpr GhcTc -> TcRn (LHsExpr GhcPs)
runMetaE = forall hs_syn.
(MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn)
-> LHsExpr GhcTc -> TcM hs_syn
runMeta forall (f :: * -> *).
Functor f =>
MetaHook f -> LHsExpr GhcTc -> f (LHsExpr GhcPs)
metaRequestE

runMetaP :: LHsExpr GhcTc          -- Of type (Q Pat)
         -> TcM (LPat GhcPs)
runMetaP :: LHsExpr GhcTc -> TcM (LPat GhcPs)
runMetaP = forall hs_syn.
(MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn)
-> LHsExpr GhcTc -> TcM hs_syn
runMeta forall (f :: * -> *).
Functor f =>
MetaHook f -> LHsExpr GhcTc -> f (LPat GhcPs)
metaRequestP

runMetaT :: LHsExpr GhcTc          -- Of type (Q Type)
         -> TcM (LHsType GhcPs)
runMetaT :: LHsExpr GhcTc -> TcM (LHsType GhcPs)
runMetaT = forall hs_syn.
(MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn)
-> LHsExpr GhcTc -> TcM hs_syn
runMeta forall (f :: * -> *).
Functor f =>
MetaHook f -> LHsExpr GhcTc -> f (LHsType GhcPs)
metaRequestT

runMetaD :: LHsExpr GhcTc          -- Of type Q [Dec]
         -> TcM [LHsDecl GhcPs]
runMetaD :: LHsExpr GhcTc -> TcM [LHsDecl GhcPs]
runMetaD = forall hs_syn.
(MetaHook TcM -> LHsExpr GhcTc -> TcM hs_syn)
-> LHsExpr GhcTc -> TcM hs_syn
runMeta forall (f :: * -> *).
Functor f =>
MetaHook f -> LHsExpr GhcTc -> f [LHsDecl GhcPs]
metaRequestD

---------------
runMeta' :: Bool                 -- Whether code should be printed in the exception message
         -> (hs_syn -> SDoc)                                    -- how to print the code
         -> (SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn))        -- How to run x
         -> LHsExpr GhcTc        -- Of type x; typically x = Q TH.Exp, or
                                 --    something like that
         -> TcM hs_syn           -- Of type t
runMeta' :: forall hs_syn.
Bool
-> (hs_syn -> SDoc)
-> (SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn))
-> LHsExpr GhcTc
-> TcM hs_syn
runMeta' Bool
show_code hs_syn -> SDoc
ppr_hs SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn)
run_and_convert LHsExpr GhcTc
expr
  = do  { String -> SDoc -> TcRn ()
traceTc String
"About to run" (forall a. Outputable a => a -> SDoc
ppr LHsExpr GhcTc
expr)
        ; TcRn ()
recordThSpliceUse -- seems to be the best place to do this,
                            -- we catch all kinds of splices and annotations.

        -- Check that we've had no errors of any sort so far.
        -- For example, if we found an error in an earlier defn f, but
        -- recovered giving it type f :: forall a.a, it'd be very dodgy
        -- to carry ont.  Mind you, the staging restrictions mean we won't
        -- actually run f, but it still seems wrong. And, more concretely,
        -- see #5358 for an example that fell over when trying to
        -- reify a function with a "?" kind in it.  (These don't occur
        -- in type-correct programs.
        ; TcRn ()
failIfErrsM

        -- run plugins
        ; HscEnv
hsc_env <- forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
        ; GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr' <- forall (m :: * -> *) a.
Monad m =>
HscEnv -> PluginOperation m a -> a -> m a
withPlugins HscEnv
hsc_env Plugin -> [String] -> LHsExpr GhcTc -> TcM (LHsExpr GhcTc)
spliceRunAction LHsExpr GhcTc
expr

        -- Desugar
        ; CoreExpr
ds_expr <- forall a. DsM a -> TcM a
initDsTc (LHsExpr GhcTc -> DsM CoreExpr
dsLExpr GenLocated SrcSpanAnnA (HsExpr GhcTc)
expr')
        -- Compile and link it; might fail if linking fails
        ; SrcSpan
src_span <- TcRn SrcSpan
getSrcSpanM
        ; String -> SDoc -> TcRn ()
traceTc String
"About to run (desugared)" (forall a. Outputable a => a -> SDoc
ppr CoreExpr
ds_expr)
        ; Either IOEnvFailure ForeignHValue
either_hval <- forall env r. IOEnv env r -> IOEnv env (Either IOEnvFailure r)
tryM forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$
                         HscEnv -> SrcSpan -> CoreExpr -> IO ForeignHValue
GHC.Driver.Main.hscCompileCoreExpr HscEnv
hsc_env SrcSpan
src_span CoreExpr
ds_expr
        ; case Either IOEnvFailure ForeignHValue
either_hval of {
            Left IOEnvFailure
exn   -> forall e a. Exception e => String -> e -> TcM a
fail_with_exn String
"compile and link" IOEnvFailure
exn ;
            Right ForeignHValue
hval -> do

        {       -- Coerce it to Q t, and run it

                -- Running might fail if it throws an exception of any kind (hence tryAllM)
                -- including, say, a pattern-match exception in the code we are running
                --
                -- We also do the TH -> HS syntax conversion inside the same
                -- exception-catching thing so that if there are any lurking
                -- exceptions in the data structure returned by hval, we'll
                -- encounter them inside the try
                --
                -- See Note [Exceptions in TH]
          let expr_span :: SrcSpan
expr_span = forall a e. GenLocated (SrcSpanAnn' a) e -> SrcSpan
getLocA LHsExpr GhcTc
expr
        ; Either SomeException hs_syn
either_tval <- forall env r. IOEnv env r -> IOEnv env (Either SomeException r)
tryAllM forall a b. (a -> b) -> a -> b
$
                         forall a. SrcSpan -> TcRn a -> TcRn a
setSrcSpan SrcSpan
expr_span forall a b. (a -> b) -> a -> b
$ -- Set the span so that qLocation can
                                                -- see where this splice is
             do { Either SDoc hs_syn
mb_result <- SrcSpan -> ForeignHValue -> TcM (Either SDoc hs_syn)
run_and_convert SrcSpan
expr_span ForeignHValue
hval
                ; case Either SDoc hs_syn
mb_result of
                    Left SDoc
err     -> forall a. SDoc -> TcM a
failWithTc SDoc
err
                    Right hs_syn
result -> do { String -> SDoc -> TcRn ()
traceTc String
"Got HsSyn result:" (hs_syn -> SDoc
ppr_hs hs_syn
result)
                                       ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$! hs_syn
result } }

        ; case Either SomeException hs_syn
either_tval of
            Right hs_syn
v -> forall (m :: * -> *) a. Monad m => a -> m a
return hs_syn
v
            Left SomeException
se -> case forall e. Exception e => SomeException -> Maybe e
fromException SomeException
se of
                         Just IOEnvFailure
IOEnvFailure -> forall env a. IOEnv env a
failM -- Error already in Tc monad
                         Maybe IOEnvFailure
_ -> forall e a. Exception e => String -> e -> TcM a
fail_with_exn String
"run" SomeException
se -- Exception
        }}}
  where
    -- see Note [Concealed TH exceptions]
    fail_with_exn :: Exception e => String -> e -> TcM a
    fail_with_exn :: forall e a. Exception e => String -> e -> TcM a
fail_with_exn String
phase e
exn = do
        String
exn_msg <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall e. Exception e => e -> IO String
Panic.safeShowException e
exn
        let msg :: SDoc
msg = [SDoc] -> SDoc
vcat [String -> SDoc
text String
"Exception when trying to" SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
phase SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"compile-time code:",
                        SumArity -> SDoc -> SDoc
nest SumArity
2 (String -> SDoc
text String
exn_msg),
                        if Bool
show_code then String -> SDoc
text String
"Code:" SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr LHsExpr GhcTc
expr else SDoc
empty]
        forall a. SDoc -> TcM a
failWithTc SDoc
msg

{-
Note [Running typed splices in the zonker]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

See #15471 for the full discussion.

For many years typed splices were run immediately after they were type checked
however, this is too early as it means to zonk some type variables before
they can be unified with type variables in the surrounding context.

For example,

```
module A where

test_foo :: forall a . Q (TExp (a -> a))
test_foo = [|| id ||]

module B where

import A

qux = $$(test_foo)
```

We would expect `qux` to have inferred type `forall a . a -> a` but if
we run the splices too early the unified variables are zonked to `Any`. The
inferred type is the unusable `Any -> Any`.

To run the splice, we must compile `test_foo` all the way to byte code.
But at the moment when the type checker is looking at the splice, test_foo
has type `Q (TExp (alpha -> alpha))` and we
certainly can't compile code involving unification variables!

We could default `alpha` to `Any` but then we infer `qux :: Any -> Any`
which definitely is not what we want.  Moreover, if we had
  qux = [$$(test_foo), (\x -> x +1::Int)]
then `alpha` would have to be `Int`.

Conclusion: we must defer taking decisions about `alpha` until the
typechecker is done; and *then* we can run the splice.  It's fine to do it
later, because we know it'll produce type-correct code.

Deferring running the splice until later, in the zonker, means that the
unification variables propagate upwards from the splice into the surrounding
context and are unified correctly.

This is implemented by storing the arguments we need for running the splice
in a `DelayedSplice`. In the zonker, the arguments are passed to
`GHC.Tc.Gen.Splice.runTopSplice` and the expression inserted into the AST as normal.



Note [Exceptions in TH]
~~~~~~~~~~~~~~~~~~~~~~~
Suppose we have something like this
        $( f 4 )
where
        f :: Int -> Q [Dec]
        f n | n>3       = fail "Too many declarations"
            | otherwise = ...

The 'fail' is a user-generated failure, and should be displayed as a
perfectly ordinary compiler error message, not a panic or anything
like that.  Here's how it's processed:

  * 'fail' is the monad fail.  The monad instance for Q in TH.Syntax
    effectively transforms (fail s) to
        qReport True s >> fail
    where 'qReport' comes from the Quasi class and fail from its monad
    superclass.

  * The TcM monad is an instance of Quasi (see GHC.Tc.Gen.Splice), and it implements
    (qReport True s) by using addErr to add an error message to the bag of errors.
    The 'fail' in TcM raises an IOEnvFailure exception

 * 'qReport' forces the message to ensure any exception hidden in unevaluated
   thunk doesn't get into the bag of errors. Otherwise the following splice
   will trigger panic (#8987):
        $(fail undefined)
   See also Note [Concealed TH exceptions]

  * So, when running a splice, we catch all exceptions; then for
        - an IOEnvFailure exception, we assume the error is already
                in the error-bag (above)
        - other errors, we add an error to the bag
    and then fail

Note [Concealed TH exceptions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When displaying the error message contained in an exception originated from TH
code, we need to make sure that the error message itself does not contain an
exception.  For example, when executing the following splice:

    $( error ("foo " ++ error "bar") )

the message for the outer exception is a thunk which will throw the inner
exception when evaluated.

For this reason, we display the message of a TH exception using the
'safeShowException' function, which recursively catches any exception thrown
when showing an error message.


To call runQ in the Tc monad, we need to make TcM an instance of Quasi:
-}

instance TH.Quasi TcM where
  qNewName :: String -> TcM Name
qNewName String
s = do { Unique
u <- forall gbl lcl. TcRnIf gbl lcl Unique
newUnique
                  ; let i :: Integer
i = forall a. Integral a => a -> Integer
toInteger (Unique -> SumArity
getKey Unique
u)
                  ; forall (m :: * -> *) a. Monad m => a -> m a
return (String -> Integer -> Name
TH.mkNameU String
s Integer
i) }

  -- 'msg' is forced to ensure exceptions don't escape,
  -- see Note [Exceptions in TH]
  qReport :: Bool -> String -> TcRn ()
qReport Bool
True String
msg  = forall a b. [a] -> b -> b
seqList String
msg forall a b. (a -> b) -> a -> b
$ SDoc -> TcRn ()
addErr  (String -> SDoc
text String
msg)
  qReport Bool
False String
msg = forall a b. [a] -> b -> b
seqList String
msg forall a b. (a -> b) -> a -> b
$ WarnReason -> SDoc -> TcRn ()
addWarn WarnReason
NoReason (String -> SDoc
text String
msg)

  qLocation :: TcM Loc
qLocation = do { GenModule Unit
m <- forall (m :: * -> *). HasModule m => m (GenModule Unit)
getModule
                 ; SrcSpan
l <- TcRn SrcSpan
getSrcSpanM
                 ; RealSrcSpan
r <- case SrcSpan
l of
                        UnhelpfulSpan UnhelpfulSpanReason
_ -> forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"qLocation: Unhelpful location"
                                                    (forall a. Outputable a => a -> SDoc
ppr SrcSpan
l)
                        RealSrcSpan RealSrcSpan
s Maybe BufSpan
_ -> forall (m :: * -> *) a. Monad m => a -> m a
return RealSrcSpan
s
                 ; forall (m :: * -> *) a. Monad m => a -> m a
return (TH.Loc { loc_filename :: String
TH.loc_filename = FastString -> String
unpackFS (RealSrcSpan -> FastString
srcSpanFile RealSrcSpan
r)
                                  , loc_module :: String
TH.loc_module   = ModuleName -> String
moduleNameString (forall unit. GenModule unit -> ModuleName
moduleName GenModule Unit
m)
                                  , loc_package :: String
TH.loc_package  = forall u. IsUnitId u => u -> String
unitString (forall unit. GenModule unit -> unit
moduleUnit GenModule Unit
m)
                                  , loc_start :: CharPos
TH.loc_start = (RealSrcSpan -> SumArity
srcSpanStartLine RealSrcSpan
r, RealSrcSpan -> SumArity
srcSpanStartCol RealSrcSpan
r)
                                  , loc_end :: CharPos
TH.loc_end = (RealSrcSpan -> SumArity
srcSpanEndLine   RealSrcSpan
r, RealSrcSpan -> SumArity
srcSpanEndCol   RealSrcSpan
r) }) }

  qLookupName :: Bool -> String -> TcM (Maybe Name)
qLookupName       = Bool -> String -> TcM (Maybe Name)
lookupName
  qReify :: Name -> TcM Info
qReify            = Name -> TcM Info
reify
  qReifyFixity :: Name -> TcM (Maybe Fixity)
qReifyFixity Name
nm   = Name -> TcM Name
lookupThName Name
nm forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= Name -> TcM (Maybe Fixity)
reifyFixity
  qReifyType :: Name -> TcM Type
qReifyType        = Name -> TcM Type
reifyTypeOfThing
  qReifyInstances :: Name -> [Type] -> TcM [Dec]
qReifyInstances   = Name -> [Type] -> TcM [Dec]
reifyInstances
  qReifyRoles :: Name -> TcM [Role]
qReifyRoles       = Name -> TcM [Role]
reifyRoles
  qReifyAnnotations :: forall a. Data a => AnnLookup -> TcM [a]
qReifyAnnotations = forall a. Data a => AnnLookup -> TcM [a]
reifyAnnotations
  qReifyModule :: Module -> TcM ModuleInfo
qReifyModule      = Module -> TcM ModuleInfo
reifyModule
  qReifyConStrictness :: Name -> TcM [DecidedStrictness]
qReifyConStrictness Name
nm = do { Name
nm' <- Name -> TcM Name
lookupThName Name
nm
                              ; DataCon
dc  <- Name -> TcM DataCon
tcLookupDataCon Name
nm'
                              ; let bangs :: [HsImplBang]
bangs = DataCon -> [HsImplBang]
dataConImplBangs DataCon
dc
                              ; forall (m :: * -> *) a. Monad m => a -> m a
return (forall a b. (a -> b) -> [a] -> [b]
map HsImplBang -> DecidedStrictness
reifyDecidedStrictness [HsImplBang]
bangs) }

        -- For qRecover, discard error messages if
        -- the recovery action is chosen.  Otherwise
        -- we'll only fail higher up.
  qRecover :: forall a. TcM a -> TcM a -> TcM a
qRecover TcM a
recover TcM a
main = forall a. TcM a -> TcM a -> TcM a
tryTcDiscardingErrs TcM a
recover TcM a
main

  qAddDependentFile :: String -> TcRn ()
qAddDependentFile String
fp = do
    TcRef [String]
ref <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> TcRef [String]
tcg_dependent_files forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
    [String]
dep_files <- forall a gbl lcl. TcRef a -> TcRnIf gbl lcl a
readTcRef TcRef [String]
ref
    forall a gbl lcl. TcRef a -> a -> TcRnIf gbl lcl ()
writeTcRef TcRef [String]
ref (String
fpforall a. a -> [a] -> [a]
:[String]
dep_files)

  qAddTempFile :: String -> IOEnv (Env TcGblEnv TcLclEnv) String
qAddTempFile String
suffix = do
    DynFlags
dflags <- forall (m :: * -> *). HasDynFlags m => m DynFlags
getDynFlags
    Logger
logger <- forall (m :: * -> *). HasLogger m => m Logger
getLogger
    TmpFs
tmpfs  <- HscEnv -> TmpFs
hsc_tmpfs forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
    forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ Logger
-> TmpFs -> DynFlags -> TempFileLifetime -> String -> IO String
newTempName Logger
logger TmpFs
tmpfs DynFlags
dflags TempFileLifetime
TFL_GhcSession String
suffix

  qAddTopDecls :: [Dec] -> TcRn ()
qAddTopDecls [Dec]
thds = do
      SrcSpan
l <- TcRn SrcSpan
getSrcSpanM
      Origin
th_origin <- TcM Origin
getThSpliceOrigin
      let either_hval :: Either SDoc [LHsDecl GhcPs]
either_hval = Origin -> SrcSpan -> [Dec] -> Either SDoc [LHsDecl GhcPs]
convertToHsDecls Origin
th_origin SrcSpan
l [Dec]
thds
      [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
ds <- case Either SDoc [LHsDecl GhcPs]
either_hval of
              Left SDoc
exn -> forall a. SDoc -> TcM a
failWithTc forall a b. (a -> b) -> a -> b
$
                SDoc -> SumArity -> SDoc -> SDoc
hang (String -> SDoc
text String
"Error in a declaration passed to addTopDecls:")
                   SumArity
2 SDoc
exn
              Right [LHsDecl GhcPs]
ds -> forall (m :: * -> *) a. Monad m => a -> m a
return [LHsDecl GhcPs]
ds
      forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ (HsDecl GhcPs -> TcRn ()
checkTopDecl forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc) [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
ds
      TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
th_topdecls_var <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> TcRef [LHsDecl GhcPs]
tcg_th_topdecls forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
      forall a gbl lcl. TcRef a -> (a -> a) -> TcRnIf gbl lcl ()
updTcRef TcRef [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
th_topdecls_var (\[GenLocated SrcSpanAnnA (HsDecl GhcPs)]
topds -> [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
ds forall a. [a] -> [a] -> [a]
++ [GenLocated SrcSpanAnnA (HsDecl GhcPs)]
topds)
    where
      checkTopDecl :: HsDecl GhcPs -> TcM ()
      checkTopDecl :: HsDecl GhcPs -> TcRn ()
checkTopDecl (ValD XValD GhcPs
_ HsBind GhcPs
binds)
        = forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ RdrName -> TcRn ()
bindName (forall p idR.
CollectPass p =>
CollectFlag p -> HsBindLR p idR -> [IdP p]
collectHsBindBinders forall p. CollectFlag p
CollNoDictBinders HsBind GhcPs
binds)
      checkTopDecl (SigD XSigD GhcPs
_ Sig GhcPs
_)
        = forall (m :: * -> *) a. Monad m => a -> m a
return ()
      checkTopDecl (AnnD XAnnD GhcPs
_ AnnDecl GhcPs
_)
        = forall (m :: * -> *) a. Monad m => a -> m a
return ()
      checkTopDecl (ForD XForD GhcPs
_ (ForeignImport { fd_name :: forall pass. ForeignDecl pass -> LIdP pass
fd_name = L SrcSpanAnnN
_ RdrName
name }))
        = RdrName -> TcRn ()
bindName RdrName
name
      checkTopDecl HsDecl GhcPs
_
        = SDoc -> TcRn ()
addErr forall a b. (a -> b) -> a -> b
$ String -> SDoc
text String
"Only function, value, annotation, and foreign import declarations may be added with addTopDecl"

      bindName :: RdrName -> TcM ()
      bindName :: RdrName -> TcRn ()
bindName (Exact Name
n)
        = do { TcRef FreeVars
th_topnames_var <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> TcRef FreeVars
tcg_th_topnames forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
             ; forall a gbl lcl. TcRef a -> (a -> a) -> TcRnIf gbl lcl ()
updTcRef TcRef FreeVars
th_topnames_var (\FreeVars
ns -> FreeVars -> Name -> FreeVars
extendNameSet FreeVars
ns Name
n)
             }

      bindName RdrName
name =
          SDoc -> TcRn ()
addErr forall a b. (a -> b) -> a -> b
$
          SDoc -> SumArity -> SDoc -> SDoc
hang (String -> SDoc
text String
"The binder" SDoc -> SDoc -> SDoc
<+> SDoc -> SDoc
quotes (forall a. Outputable a => a -> SDoc
ppr RdrName
name) SDoc -> SDoc -> SDoc
<+> PtrString -> SDoc
ptext (String -> PtrString
sLit String
"is not a NameU."))
             SumArity
2 (String -> SDoc
text String
"Probable cause: you used mkName instead of newName to generate a binding.")

  qAddForeignFilePath :: ForeignSrcLang -> String -> TcRn ()
qAddForeignFilePath ForeignSrcLang
lang String
fp = do
    TcRef [(ForeignSrcLang, String)]
var <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> TcRef [(ForeignSrcLang, String)]
tcg_th_foreign_files forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
    forall a gbl lcl. TcRef a -> (a -> a) -> TcRnIf gbl lcl ()
updTcRef TcRef [(ForeignSrcLang, String)]
var ((ForeignSrcLang
lang, String
fp) forall a. a -> [a] -> [a]
:)

  qAddModFinalizer :: Q () -> TcRn ()
qAddModFinalizer Q ()
fin = do
      RemoteRef (Q ())
r <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall a. a -> IO (RemoteRef a)
mkRemoteRef Q ()
fin
      ForeignRef (Q ())
fref <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall a. RemoteRef a -> IO () -> IO (ForeignRef a)
mkForeignRef RemoteRef (Q ())
r (forall a. RemoteRef a -> IO ()
freeRemoteRef RemoteRef (Q ())
r)
      ForeignRef (Q ()) -> TcRn ()
addModFinalizerRef ForeignRef (Q ())
fref

  qAddCorePlugin :: String -> TcRn ()
qAddCorePlugin String
plugin = do
      HscEnv
hsc_env <- forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
      FindResult
r <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ HscEnv -> ModuleName -> IO FindResult
findHomeModule HscEnv
hsc_env (String -> ModuleName
mkModuleName String
plugin)
      let err :: SDoc
err = SDoc -> SumArity -> SDoc -> SDoc
hang
            (String -> SDoc
text String
"addCorePlugin: invalid plugin module "
               SDoc -> SDoc -> SDoc
<+> String -> SDoc
text (forall a. Show a => a -> String
show String
plugin)
            )
            SumArity
2
            (String -> SDoc
text String
"Plugins in the current package can't be specified.")
      case FindResult
r of
        Found {} -> SDoc -> TcRn ()
addErr SDoc
err
        FoundMultiple {} -> SDoc -> TcRn ()
addErr SDoc
err
        FindResult
_ -> forall (m :: * -> *) a. Monad m => a -> m a
return ()
      TcRef [String]
th_coreplugins_var <- TcGblEnv -> TcRef [String]
tcg_th_coreplugins forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
      forall a gbl lcl. TcRef a -> (a -> a) -> TcRnIf gbl lcl ()
updTcRef TcRef [String]
th_coreplugins_var (String
pluginforall a. a -> [a] -> [a]
:)

  qGetQ :: forall a. Typeable a => TcM (Maybe a)
  qGetQ :: forall a. Typeable a => TcM (Maybe a)
qGetQ = do
      TcRef (Map TypeRep Dynamic)
th_state_var <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> TcRef (Map TypeRep Dynamic)
tcg_th_state forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
      Map TypeRep Dynamic
th_state <- forall a gbl lcl. TcRef a -> TcRnIf gbl lcl a
readTcRef TcRef (Map TypeRep Dynamic)
th_state_var
      -- See #10596 for why we use a scoped type variable here.
      forall (m :: * -> *) a. Monad m => a -> m a
return (forall k a. Ord k => k -> Map k a -> Maybe a
Map.lookup (forall {k} (proxy :: k -> *) (a :: k).
Typeable a =>
proxy a -> TypeRep
typeRep (forall {k} (t :: k). Proxy t
Proxy :: Proxy a)) Map TypeRep Dynamic
th_state forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= forall a. Typeable a => Dynamic -> Maybe a
fromDynamic)

  qPutQ :: forall a. Typeable a => a -> TcRn ()
qPutQ a
x = do
      TcRef (Map TypeRep Dynamic)
th_state_var <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap TcGblEnv -> TcRef (Map TypeRep Dynamic)
tcg_th_state forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
      forall a gbl lcl. TcRef a -> (a -> a) -> TcRnIf gbl lcl ()
updTcRef TcRef (Map TypeRep Dynamic)
th_state_var (\Map TypeRep Dynamic
m -> forall k a. Ord k => k -> a -> Map k a -> Map k a
Map.insert (forall a. Typeable a => a -> TypeRep
typeOf a
x) (forall a. Typeable a => a -> Dynamic
toDyn a
x) Map TypeRep Dynamic
m)

  qIsExtEnabled :: Extension -> TcM Bool
qIsExtEnabled = forall gbl lcl. Extension -> TcRnIf gbl lcl Bool
xoptM

  qExtsEnabled :: TcM [Extension]
qExtsEnabled =
    forall a. Enum a => EnumSet a -> [a]
EnumSet.toList forall b c a. (b -> c) -> (a -> b) -> a -> c
. DynFlags -> EnumSet Extension
extensionFlags forall b c a. (b -> c) -> (a -> b) -> a -> c
. HscEnv -> DynFlags
hsc_dflags forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv

  qPutDoc :: DocLoc -> String -> TcRn ()
qPutDoc DocLoc
doc_loc String
s = do
    TcRef THDocs
th_doc_var <- TcGblEnv -> TcRef THDocs
tcg_th_docs forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
    DocLoc
resolved_doc_loc <- DocLoc -> IOEnv (Env TcGblEnv TcLclEnv) DocLoc
resolve_loc DocLoc
doc_loc
    Bool
is_local <- forall {f :: * -> *}.
(Applicative f, HasModule f) =>
DocLoc -> f Bool
checkLocalName DocLoc
resolved_doc_loc
    forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless Bool
is_local forall a b. (a -> b) -> a -> b
$ forall a. SDoc -> TcM a
failWithTc forall a b. (a -> b) -> a -> b
$ String -> SDoc
text
      String
"Can't add documentation to" SDoc -> SDoc -> SDoc
<+> DocLoc -> SDoc
ppr_loc DocLoc
doc_loc SDoc -> SDoc -> SDoc
<+>
      String -> SDoc
text String
"as it isn't inside the current module"
    forall a gbl lcl. TcRef a -> (a -> a) -> TcRnIf gbl lcl ()
updTcRef TcRef THDocs
th_doc_var (forall k a. Ord k => k -> a -> Map k a -> Map k a
Map.insert DocLoc
resolved_doc_loc String
s)
    where
      resolve_loc :: DocLoc -> IOEnv (Env TcGblEnv TcLclEnv) DocLoc
resolve_loc (TH.DeclDoc Name
n) = Name -> DocLoc
DeclDoc forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Name -> TcM Name
lookupThName Name
n
      resolve_loc (TH.ArgDoc Name
n SumArity
i) = Name -> SumArity -> DocLoc
ArgDoc forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Name -> TcM Name
lookupThName Name
n forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> forall (f :: * -> *) a. Applicative f => a -> f a
pure SumArity
i
      resolve_loc (TH.InstDoc Type
t) = Name -> DocLoc
InstDoc forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall a. NamedThing a => a -> Name
getName (Type -> TcM Name
lookupThInstName Type
t)
      resolve_loc DocLoc
TH.ModuleDoc = forall (f :: * -> *) a. Applicative f => a -> f a
pure DocLoc
ModuleDoc

      ppr_loc :: DocLoc -> SDoc
ppr_loc (TH.DeclDoc Name
n) = forall a. Ppr a => a -> SDoc
ppr_th Name
n
      ppr_loc (TH.ArgDoc Name
n SumArity
_) = forall a. Ppr a => a -> SDoc
ppr_th Name
n
      ppr_loc (TH.InstDoc Type
t) = forall a. Ppr a => a -> SDoc
ppr_th Type
t
      ppr_loc DocLoc
TH.ModuleDoc = String -> SDoc
text String
"the module header"

      -- It doesn't make sense to add documentation to something not inside
      -- the current module. So check for it!
      checkLocalName :: DocLoc -> f Bool
checkLocalName (DeclDoc Name
n) = GenModule Unit -> Name -> Bool
nameIsLocalOrFrom forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *). HasModule m => m (GenModule Unit)
getModule forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
n
      checkLocalName (ArgDoc Name
n SumArity
_) = GenModule Unit -> Name -> Bool
nameIsLocalOrFrom forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *). HasModule m => m (GenModule Unit)
getModule forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
n
      checkLocalName (InstDoc Name
n) = GenModule Unit -> Name -> Bool
nameIsLocalOrFrom forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *). HasModule m => m (GenModule Unit)
getModule forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
n
      checkLocalName DocLoc
ModuleDoc = forall (f :: * -> *) a. Applicative f => a -> f a
pure Bool
True


  qGetDoc :: DocLoc -> TcM (Maybe String)
qGetDoc (TH.DeclDoc Name
n) = Name -> TcM Name
lookupThName Name
n forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= Name -> TcM (Maybe String)
lookupDeclDoc
  qGetDoc (TH.InstDoc Type
t) = Type -> TcM Name
lookupThInstName Type
t forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= Name -> TcM (Maybe String)
lookupDeclDoc
  qGetDoc (TH.ArgDoc Name
n SumArity
i) = Name -> TcM Name
lookupThName Name
n forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= SumArity -> Name -> TcM (Maybe String)
lookupArgDoc SumArity
i
  qGetDoc DocLoc
TH.ModuleDoc = do
    (Maybe HsDocString
moduleDoc, DeclDocMap
_, ArgDocMap
_) <- forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= forall (m :: * -> *).
MonadIO m =>
TcGblEnv -> m (Maybe HsDocString, DeclDocMap, ArgDocMap)
extractDocs
    forall (m :: * -> *) a. Monad m => a -> m a
return (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap HsDocString -> String
unpackHDS Maybe HsDocString
moduleDoc)

-- | Looks up documentation for a declaration in first the current module,
-- otherwise tries to find it in another module via 'hscGetModuleInterface'.
lookupDeclDoc :: Name -> TcM (Maybe String)
lookupDeclDoc :: Name -> TcM (Maybe String)
lookupDeclDoc Name
nm = do
  (Maybe HsDocString
_, DeclDocMap Map Name HsDocString
declDocs, ArgDocMap
_) <- forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= forall (m :: * -> *).
MonadIO m =>
TcGblEnv -> m (Maybe HsDocString, DeclDocMap, ArgDocMap)
extractDocs
  [FamInst]
fam_insts <- TcGblEnv -> [FamInst]
tcg_fam_insts forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
  String -> SDoc -> TcRn ()
traceTc String
"lookupDeclDoc" (forall a. Outputable a => a -> SDoc
ppr Name
nm SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr Map Name HsDocString
declDocs SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr [FamInst]
fam_insts)
  case forall k a. Ord k => k -> Map k a -> Maybe a
Map.lookup Name
nm Map Name HsDocString
declDocs of
    Just HsDocString
doc -> forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ forall a. a -> Maybe a
Just (HsDocString -> String
unpackHDS HsDocString
doc)
    Maybe HsDocString
Nothing -> do
      -- Wasn't in the current module. Try searching other external ones!
      Maybe ModIface
mIface <- Name -> TcM (Maybe ModIface)
getExternalModIface Name
nm
      case Maybe ModIface
mIface of
        Maybe ModIface
Nothing -> forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a. Maybe a
Nothing
        Just ModIface { mi_decl_docs :: forall (phase :: ModIfacePhase). ModIface_ phase -> DeclDocMap
mi_decl_docs = DeclDocMap Map Name HsDocString
dmap } ->
          forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ HsDocString -> String
unpackHDS forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall k a. Ord k => k -> Map k a -> Maybe a
Map.lookup Name
nm Map Name HsDocString
dmap

-- | Like 'lookupDeclDoc', looks up documentation for a function argument. If
-- it can't find any documentation for a function in this module, it tries to
-- find it in another module.
lookupArgDoc :: Int -> Name -> TcM (Maybe String)
lookupArgDoc :: SumArity -> Name -> TcM (Maybe String)
lookupArgDoc SumArity
i Name
nm = do
  (Maybe HsDocString
_, DeclDocMap
_, ArgDocMap Map Name (IntMap HsDocString)
argDocs) <- forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= forall (m :: * -> *).
MonadIO m =>
TcGblEnv -> m (Maybe HsDocString, DeclDocMap, ArgDocMap)
extractDocs
  case forall k a. Ord k => k -> Map k a -> Maybe a
Map.lookup Name
nm Map Name (IntMap HsDocString)
argDocs of
    Just IntMap HsDocString
m -> forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ HsDocString -> String
unpackHDS forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall a. SumArity -> IntMap a -> Maybe a
IntMap.lookup SumArity
i IntMap HsDocString
m
    Maybe (IntMap HsDocString)
Nothing -> do
      Maybe ModIface
mIface <- Name -> TcM (Maybe ModIface)
getExternalModIface Name
nm
      case Maybe ModIface
mIface of
        Maybe ModIface
Nothing -> forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a. Maybe a
Nothing
        Just ModIface { mi_arg_docs :: forall (phase :: ModIfacePhase). ModIface_ phase -> ArgDocMap
mi_arg_docs = ArgDocMap Map Name (IntMap HsDocString)
amap } ->
          forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ HsDocString -> String
unpackHDS forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (forall k a. Ord k => k -> Map k a -> Maybe a
Map.lookup Name
nm Map Name (IntMap HsDocString)
amap forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= forall a. SumArity -> IntMap a -> Maybe a
IntMap.lookup SumArity
i)

-- | Returns the module a Name belongs to, if it is isn't local.
getExternalModIface :: Name -> TcM (Maybe ModIface)
getExternalModIface :: Name -> TcM (Maybe ModIface)
getExternalModIface Name
nm = do
  Bool
isLocal <- GenModule Unit -> Name -> Bool
nameIsLocalOrFrom forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall (m :: * -> *). HasModule m => m (GenModule Unit)
getModule forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
nm
  if Bool
isLocal
    then forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a. Maybe a
Nothing
    else case Name -> Maybe (GenModule Unit)
nameModule_maybe Name
nm of
          Maybe (GenModule Unit)
Nothing -> forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a. Maybe a
Nothing
          Just GenModule Unit
modNm -> do
            HscEnv
hsc_env <- forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
            ModIface
iface <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ HscEnv -> GenModule Unit -> IO ModIface
hscGetModuleInterface HscEnv
hsc_env GenModule Unit
modNm
            forall (f :: * -> *) a. Applicative f => a -> f a
pure (forall a. a -> Maybe a
Just ModIface
iface)

-- | Find the GHC name of the first instance that matches the TH type
lookupThInstName :: TH.Type -> TcM Name
lookupThInstName :: Type -> TcM Name
lookupThInstName Type
th_type = do
  Name
cls_name <- Type -> TcM Name
inst_cls_name Type
th_type
  Either (Class, [ClsInst]) (TyCon, [FamInst])
insts <- Name
-> [Type] -> TcM (Either (Class, [ClsInst]) (TyCon, [FamInst]))
reifyInstances' Name
cls_name (Type -> [Type]
inst_arg_types Type
th_type)
  case Either (Class, [ClsInst]) (TyCon, [FamInst])
insts of   -- This expands any type synonyms
    Left  (Class
_, (ClsInst
inst:[ClsInst]
_)) -> forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a. NamedThing a => a -> Name
getName ClsInst
inst
    Left  (Class
_, [])       -> TcM Name
noMatches
    Right (TyCon
_, (FamInst
inst:[FamInst]
_)) -> forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a. NamedThing a => a -> Name
getName FamInst
inst
    Right (TyCon
_, [])       -> TcM Name
noMatches
  where
    noMatches :: TcM Name
noMatches = forall a. SDoc -> TcM a
failWithTc forall a b. (a -> b) -> a -> b
$
      String -> SDoc
text String
"Couldn't find any instances of"
        SDoc -> SDoc -> SDoc
<+> forall a. Ppr a => a -> SDoc
ppr_th Type
th_type
        SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"to add documentation to"

    -- | Get the name of the class for the instance we are documenting
    -- > inst_cls_name (Monad Maybe) == Monad
    -- > inst_cls_name C = C
    inst_cls_name :: TH.Type -> TcM TH.Name
    inst_cls_name :: Type -> TcM Name
inst_cls_name (TH.AppT Type
t Type
_)           = Type -> TcM Name
inst_cls_name Type
t
    inst_cls_name (TH.SigT Type
n Type
_)           = Type -> TcM Name
inst_cls_name Type
n
    inst_cls_name (TH.VarT Name
n)             = forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
n
    inst_cls_name (TH.ConT Name
n)             = forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
n
    inst_cls_name (TH.PromotedT Name
n)        = forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
n
    inst_cls_name (TH.InfixT Type
_ Name
n Type
_)       = forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
n
    inst_cls_name (TH.UInfixT Type
_ Name
n Type
_)      = forall (f :: * -> *) a. Applicative f => a -> f a
pure Name
n
    inst_cls_name (TH.ParensT Type
t)          = Type -> TcM Name
inst_cls_name Type
t

    inst_cls_name (TH.ForallT [TyVarBndr Specificity]
_ [Type]
_ Type
_)      = TcM Name
inst_cls_name_err
    inst_cls_name (TH.ForallVisT [TyVarBndr ()]
_ Type
_)     = TcM Name
inst_cls_name_err
    inst_cls_name (TH.AppKindT Type
_ Type
_)       = TcM Name
inst_cls_name_err
    inst_cls_name (TH.TupleT SumArity
_)           = TcM Name
inst_cls_name_err
    inst_cls_name (TH.UnboxedTupleT SumArity
_)    = TcM Name
inst_cls_name_err
    inst_cls_name (TH.UnboxedSumT SumArity
_)      = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.ArrowT               = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.MulArrowT            = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.EqualityT            = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.ListT                = TcM Name
inst_cls_name_err
    inst_cls_name (TH.PromotedTupleT SumArity
_)   = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.PromotedNilT         = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.PromotedConsT        = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.StarT                = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.ConstraintT          = TcM Name
inst_cls_name_err
    inst_cls_name (TH.LitT TyLit
_)             = TcM Name
inst_cls_name_err
    inst_cls_name Type
TH.WildCardT            = TcM Name
inst_cls_name_err
    inst_cls_name (TH.ImplicitParamT String
_ Type
_) = TcM Name
inst_cls_name_err

    inst_cls_name_err :: TcM Name
inst_cls_name_err = forall a. SDoc -> TcM a
failWithTc forall a b. (a -> b) -> a -> b
$
      String -> SDoc
text String
"Couldn't work out what instance"
        SDoc -> SDoc -> SDoc
<+> forall a. Ppr a => a -> SDoc
ppr_th Type
th_type
        SDoc -> SDoc -> SDoc
<+> String -> SDoc
text String
"is supposed to be"

    -- | Basically does the opposite of 'mkThAppTs'
    -- > inst_arg_types (Monad Maybe) == [Maybe]
    -- > inst_arg_types C == []
    inst_arg_types :: TH.Type -> [TH.Type]
    inst_arg_types :: Type -> [Type]
inst_arg_types (TH.AppT Type
_ Type
args) =
      let go :: Type -> [Type]
go (TH.AppT Type
t Type
ts) = Type
tforall a. a -> [a] -> [a]
:Type -> [Type]
go Type
ts
          go Type
t = [Type
t]
        in Type -> [Type]
go Type
args
    inst_arg_types Type
_ = []

-- | Adds a mod finalizer reference to the local environment.
addModFinalizerRef :: ForeignRef (TH.Q ()) -> TcM ()
addModFinalizerRef :: ForeignRef (Q ()) -> TcRn ()
addModFinalizerRef ForeignRef (Q ())
finRef = do
    ThStage
th_stage <- TcM ThStage
getStage
    case ThStage
th_stage of
      RunSplice TcRef [ForeignRef (Q ())]
th_modfinalizers_var -> forall a gbl lcl. TcRef a -> (a -> a) -> TcRnIf gbl lcl ()
updTcRef TcRef [ForeignRef (Q ())]
th_modfinalizers_var (ForeignRef (Q ())
finRef forall a. a -> [a] -> [a]
:)
      -- This case happens only if a splice is executed and the caller does
      -- not set the 'ThStage' to 'RunSplice' to collect finalizers.
      -- See Note [Delaying modFinalizers in untyped splices] in GHC.Rename.Splice.
      ThStage
_ ->
        forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"addModFinalizer was called when no finalizers were collected"
                 (forall a. Outputable a => a -> SDoc
ppr ThStage
th_stage)

-- | Releases the external interpreter state.
finishTH :: TcM ()
finishTH :: TcRn ()
finishTH = do
  HscEnv
hsc_env <- forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
  case Interp -> InterpInstance
interpInstance forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> HscEnv -> Maybe Interp
hsc_interp HscEnv
hsc_env of
    Maybe InterpInstance
Nothing                  -> forall (f :: * -> *) a. Applicative f => a -> f a
pure ()
#if defined(HAVE_INTERNAL_INTERPRETER)
    Just InterpInstance
InternalInterp      -> forall (f :: * -> *) a. Applicative f => a -> f a
pure ()
#endif
    Just (ExternalInterp {}) -> do
      TcGblEnv
tcg <- forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
      forall a gbl lcl. TcRef a -> a -> TcRnIf gbl lcl ()
writeTcRef (TcGblEnv -> TcRef (Maybe (ForeignRef (IORef QState)))
tcg_th_remote_state TcGblEnv
tcg) forall a. Maybe a
Nothing


runTHExp :: ForeignHValue -> TcM TH.Exp
runTHExp :: ForeignHValue -> TcM Exp
runTHExp = forall a. Binary a => THResultType -> ForeignHValue -> TcM a
runTH THResultType
THExp

runTHPat :: ForeignHValue -> TcM TH.Pat
runTHPat :: ForeignHValue -> TcM Pat
runTHPat = forall a. Binary a => THResultType -> ForeignHValue -> TcM a
runTH THResultType
THPat

runTHType :: ForeignHValue -> TcM TH.Type
runTHType :: ForeignHValue -> TcM Type
runTHType = forall a. Binary a => THResultType -> ForeignHValue -> TcM a
runTH THResultType
THType

runTHDec :: ForeignHValue -> TcM [TH.Dec]
runTHDec :: ForeignHValue -> TcM [Dec]
runTHDec = forall a. Binary a => THResultType -> ForeignHValue -> TcM a
runTH THResultType
THDec

runTH :: Binary a => THResultType -> ForeignHValue -> TcM a
runTH :: forall a. Binary a => THResultType -> ForeignHValue -> TcM a
runTH THResultType
ty ForeignHValue
fhv = do
  Interp
interp <- TcM Interp
tcGetInterp
  case Interp -> InterpInstance
interpInstance Interp
interp of
#if defined(HAVE_INTERNAL_INTERPRETER)
    InterpInstance
InternalInterp -> do
       -- Run it in the local TcM
      HValue
hv <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall a. Interp -> ForeignRef a -> IO a
wormhole Interp
interp ForeignHValue
fhv
      a
r <- forall a. Q a -> TcM a
runQuasi (forall a b. a -> b
unsafeCoerce HValue
hv :: TH.Q a)
      forall (m :: * -> *) a. Monad m => a -> m a
return a
r
#endif

    ExternalInterp IServConfig
conf IServ
iserv ->
      -- Run it on the server.  For an overview of how TH works with
      -- Remote GHCi, see Note [Remote Template Haskell] in
      -- libraries/ghci/GHCi/TH.hs.
      forall (m :: * -> *) a.
(MonadIO m, ExceptionMonad m) =>
IServConfig -> IServ -> (IServInstance -> m a) -> m a
withIServ_ IServConfig
conf IServ
iserv forall a b. (a -> b) -> a -> b
$ \IServInstance
i -> do
        ForeignRef (IORef QState)
rstate <- IServInstance -> TcM (ForeignRef (IORef QState))
getTHState IServInstance
i
        Loc
loc <- forall (m :: * -> *). Quasi m => m Loc
TH.qLocation
        forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$
          forall a b. ForeignRef a -> (RemoteRef a -> IO b) -> IO b
withForeignRef ForeignRef (IORef QState)
rstate forall a b. (a -> b) -> a -> b
$ \RemoteRef (IORef QState)
state_hv ->
          forall a b. ForeignRef a -> (RemoteRef a -> IO b) -> IO b
withForeignRef ForeignHValue
fhv forall a b. (a -> b) -> a -> b
$ \RemoteRef HValue
q_hv ->
            IServInstance -> Put -> IO ()
writeIServ IServInstance
i (forall a. Message a -> Put
putMessage (RemoteRef (IORef QState)
-> RemoteRef HValue
-> THResultType
-> Maybe Loc
-> Message (QResult ByteString)
RunTH RemoteRef (IORef QState)
state_hv RemoteRef HValue
q_hv THResultType
ty (forall a. a -> Maybe a
Just Loc
loc)))
        IServInstance -> [Messages DecoratedSDoc] -> TcRn ()
runRemoteTH IServInstance
i []
        ByteString
bs <- forall a. Binary a => IServInstance -> TcM a
readQResult IServInstance
i
        forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$! forall a. Get a -> ByteString -> a
runGet forall t. Binary t => Get t
get (ByteString -> ByteString
LB.fromStrict ByteString
bs)


-- | communicate with a remotely-running TH computation until it finishes.
-- See Note [Remote Template Haskell] in libraries/ghci/GHCi/TH.hs.
runRemoteTH
  :: IServInstance
  -> [Messages DecoratedSDoc]   --  saved from nested calls to qRecover
  -> TcM ()
runRemoteTH :: IServInstance -> [Messages DecoratedSDoc] -> TcRn ()
runRemoteTH IServInstance
iserv [Messages DecoratedSDoc]
recovers = do
  THMsg THMessage a
msg <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall a. IServInstance -> Get a -> IO a
readIServ IServInstance
iserv Get THMsg
getTHMessage
  case THMessage a
msg of
    THMessage a
RunTHDone -> forall (m :: * -> *) a. Monad m => a -> m a
return ()
    THMessage a
StartRecover -> do -- Note [TH recover with -fexternal-interpreter]
      TcRef (Messages DecoratedSDoc)
v <- TcRn (TcRef (Messages DecoratedSDoc))
getErrsVar
      Messages DecoratedSDoc
msgs <- forall a gbl lcl. TcRef a -> TcRnIf gbl lcl a
readTcRef TcRef (Messages DecoratedSDoc)
v
      forall a gbl lcl. TcRef a -> a -> TcRnIf gbl lcl ()
writeTcRef TcRef (Messages DecoratedSDoc)
v forall e. Messages e
emptyMessages
      IServInstance -> [Messages DecoratedSDoc] -> TcRn ()
runRemoteTH IServInstance
iserv (Messages DecoratedSDoc
msgs forall a. a -> [a] -> [a]
: [Messages DecoratedSDoc]
recovers)
    EndRecover Bool
caught_error -> do
      let (Messages DecoratedSDoc
prev_msgs, [Messages DecoratedSDoc]
rest) = case [Messages DecoratedSDoc]
recovers of
             [] -> forall a. String -> a
panic String
"EndRecover"
             Messages DecoratedSDoc
a : [Messages DecoratedSDoc]
b -> (Messages DecoratedSDoc
a,[Messages DecoratedSDoc]
b)
      TcRef (Messages DecoratedSDoc)
v <- TcRn (TcRef (Messages DecoratedSDoc))
getErrsVar
      Bag (MsgEnvelope DecoratedSDoc)
warn_msgs <- forall e. Messages e -> Bag (MsgEnvelope e)
getWarningMessages forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall a gbl lcl. TcRef a -> TcRnIf gbl lcl a
readTcRef TcRef (Messages DecoratedSDoc)
v
      -- keep the warnings only if there were no errors
      forall a gbl lcl. TcRef a -> a -> TcRnIf gbl lcl ()
writeTcRef TcRef (Messages DecoratedSDoc)
v forall a b. (a -> b) -> a -> b
$ if Bool
caught_error
        then Messages DecoratedSDoc
prev_msgs
        else forall e. Bag (MsgEnvelope e) -> Messages e
mkMessages Bag (MsgEnvelope DecoratedSDoc)
warn_msgs forall e. Messages e -> Messages e -> Messages e
`unionMessages` Messages DecoratedSDoc
prev_msgs
      IServInstance -> [Messages DecoratedSDoc] -> TcRn ()
runRemoteTH IServInstance
iserv [Messages DecoratedSDoc]
rest
    THMessage a
_other -> do
      a
r <- forall a. THMessage a -> TcM a
handleTHMessage THMessage a
msg
      forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ IServInstance -> Put -> IO ()
writeIServ IServInstance
iserv (forall t. Binary t => t -> Put
put a
r)
      IServInstance -> [Messages DecoratedSDoc] -> TcRn ()
runRemoteTH IServInstance
iserv [Messages DecoratedSDoc]
recovers

-- | Read a value of type QResult from the iserv
readQResult :: Binary a => IServInstance -> TcM a
readQResult :: forall a. Binary a => IServInstance -> TcM a
readQResult IServInstance
i = do
  QResult a
qr <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall a. IServInstance -> Get a -> IO a
readIServ IServInstance
i forall t. Binary t => Get t
get
  case QResult a
qr of
    QDone a
a -> forall (m :: * -> *) a. Monad m => a -> m a
return a
a
    QException String
str -> forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall e a. Exception e => e -> IO a
throwIO (String -> ErrorCall
ErrorCall String
str)
    QFail String
str -> forall (m :: * -> *) a. MonadFail m => String -> m a
fail String
str

{- Note [TH recover with -fexternal-interpreter]

Recover is slightly tricky to implement.

The meaning of "recover a b" is
 - Do a
   - If it finished with no errors, then keep the warnings it generated
   - If it failed, discard any messages it generated, and do b

Note that "failed" here can mean either
  (1) threw an exception (failTc)
  (2) generated an error message (addErrTcM)

The messages are managed by GHC in the TcM monad, whereas the
exception-handling is done in the ghc-iserv process, so we have to
coordinate between the two.

On the server:
  - emit a StartRecover message
  - run "a; FailIfErrs" inside a try
  - emit an (EndRecover x) message, where x = True if "a; FailIfErrs" failed
  - if "a; FailIfErrs" failed, run "b"

Back in GHC, when we receive:

  FailIfErrrs
    failTc if there are any error messages (= failIfErrsM)
  StartRecover
    save the current messages and start with an empty set.
  EndRecover caught_error
    Restore the previous messages,
    and merge in the new messages if caught_error is false.
-}

-- | Retrieve (or create, if it hasn't been created already), the
-- remote TH state.  The TH state is a remote reference to an IORef
-- QState living on the server, and we have to pass this to each RunTH
-- call we make.
--
-- The TH state is stored in tcg_th_remote_state in the TcGblEnv.
--
getTHState :: IServInstance -> TcM (ForeignRef (IORef QState))
getTHState :: IServInstance -> TcM (ForeignRef (IORef QState))
getTHState IServInstance
i = do
  TcGblEnv
tcg <- forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
  Maybe (ForeignRef (IORef QState))
th_state <- forall a gbl lcl. TcRef a -> TcRnIf gbl lcl a
readTcRef (TcGblEnv -> TcRef (Maybe (ForeignRef (IORef QState)))
tcg_th_remote_state TcGblEnv
tcg)
  case Maybe (ForeignRef (IORef QState))
th_state of
    Just ForeignRef (IORef QState)
rhv -> forall (m :: * -> *) a. Monad m => a -> m a
return ForeignRef (IORef QState)
rhv
    Maybe (ForeignRef (IORef QState))
Nothing -> do
      Interp
interp <- TcM Interp
tcGetInterp
      ForeignRef (IORef QState)
fhv <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall a. Interp -> RemoteRef a -> IO (ForeignRef a)
mkFinalizedHValue Interp
interp forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< forall a. Binary a => IServInstance -> Message a -> IO a
iservCall IServInstance
i Message (RemoteRef (IORef QState))
StartTH
      forall a gbl lcl. TcRef a -> a -> TcRnIf gbl lcl ()
writeTcRef (TcGblEnv -> TcRef (Maybe (ForeignRef (IORef QState)))
tcg_th_remote_state TcGblEnv
tcg) (forall a. a -> Maybe a
Just ForeignRef (IORef QState)
fhv)
      forall (m :: * -> *) a. Monad m => a -> m a
return ForeignRef (IORef QState)
fhv

wrapTHResult :: TcM a -> TcM (THResult a)
wrapTHResult :: forall a. TcM a -> TcM (THResult a)
wrapTHResult TcM a
tcm = do
  Either IOEnvFailure a
e <- forall env r. IOEnv env r -> IOEnv env (Either IOEnvFailure r)
tryM TcM a
tcm   -- only catch 'fail', treat everything else as catastrophic
  case Either IOEnvFailure a
e of
    Left IOEnvFailure
e -> forall (m :: * -> *) a. Monad m => a -> m a
return (forall a. String -> THResult a
THException (forall a. Show a => a -> String
show IOEnvFailure
e))
    Right a
a -> forall (m :: * -> *) a. Monad m => a -> m a
return (forall a. a -> THResult a
THComplete a
a)

handleTHMessage :: THMessage a -> TcM a
handleTHMessage :: forall a. THMessage a -> TcM a
handleTHMessage THMessage a
msg = case THMessage a
msg of
  NewName String
a -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => String -> m Name
TH.qNewName String
a
  Report Bool
b String
str -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Bool -> String -> m ()
TH.qReport Bool
b String
str
  LookupName Bool
b String
str -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Bool -> String -> m (Maybe Name)
TH.qLookupName Bool
b String
str
  Reify Name
n -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Name -> m Info
TH.qReify Name
n
  ReifyFixity Name
n -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Name -> m (Maybe Fixity)
TH.qReifyFixity Name
n
  ReifyType Name
n -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Name -> m Type
TH.qReifyType Name
n
  ReifyInstances Name
n [Type]
ts -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Name -> [Type] -> m [Dec]
TH.qReifyInstances Name
n [Type]
ts
  ReifyRoles Name
n -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Name -> m [Role]
TH.qReifyRoles Name
n
  ReifyAnnotations AnnLookup
lookup TypeRep
tyrep ->
    forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ (forall a b. (a -> b) -> [a] -> [b]
map [Word8] -> ByteString
B.pack forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> AnnLookup -> TypeRep -> TcM [[Word8]]
getAnnotationsByTypeRep AnnLookup
lookup TypeRep
tyrep)
  ReifyModule Module
m -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Module -> m ModuleInfo
TH.qReifyModule Module
m
  ReifyConStrictness Name
nm -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Name -> m [DecidedStrictness]
TH.qReifyConStrictness Name
nm
  AddDependentFile String
f -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => String -> m ()
TH.qAddDependentFile String
f
  AddTempFile String
s -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => String -> m String
TH.qAddTempFile String
s
  AddModFinalizer RemoteRef (Q ())
r -> do
    Interp
interp <- HscEnv -> Interp
hscInterp forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
    forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (forall a. Interp -> RemoteRef a -> IO (ForeignRef a)
mkFinalizedHValue Interp
interp RemoteRef (Q ())
r) forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= ForeignRef (Q ()) -> TcRn ()
addModFinalizerRef
  AddCorePlugin String
str -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => String -> m ()
TH.qAddCorePlugin String
str
  AddTopDecls [Dec]
decs -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => [Dec] -> m ()
TH.qAddTopDecls [Dec]
decs
  AddForeignFilePath ForeignSrcLang
lang String
str -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => ForeignSrcLang -> String -> m ()
TH.qAddForeignFilePath ForeignSrcLang
lang String
str
  IsExtEnabled Extension
ext -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => Extension -> m Bool
TH.qIsExtEnabled Extension
ext
  THMessage a
ExtsEnabled -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => m [Extension]
TH.qExtsEnabled
  PutDoc DocLoc
l String
s -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => DocLoc -> String -> m ()
TH.qPutDoc DocLoc
l String
s
  GetDoc DocLoc
l -> forall a. TcM a -> TcM (THResult a)
wrapTHResult forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *). Quasi m => DocLoc -> m (Maybe String)
TH.qGetDoc DocLoc
l
  THMessage a
FailIfErrs -> forall a. TcM a -> TcM (THResult a)
wrapTHResult TcRn ()
failIfErrsM
  THMessage a
_ -> forall a. String -> a
panic (String
"handleTHMessage: unexpected message " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show THMessage a
msg)

getAnnotationsByTypeRep :: TH.AnnLookup -> TypeRep -> TcM [[Word8]]
getAnnotationsByTypeRep :: AnnLookup -> TypeRep -> TcM [[Word8]]
getAnnotationsByTypeRep AnnLookup
th_name TypeRep
tyrep
  = do { CoreAnnTarget
name <- AnnLookup -> TcM CoreAnnTarget
lookupThAnnLookup AnnLookup
th_name
       ; HscEnv
topEnv <- forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
       ; AnnEnv
epsHptAnns <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ HscEnv -> Maybe ModGuts -> IO AnnEnv
prepareAnnotations HscEnv
topEnv forall a. Maybe a
Nothing
       ; TcGblEnv
tcg <- forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
       ; let selectedEpsHptAnns :: [[Word8]]
selectedEpsHptAnns = AnnEnv -> CoreAnnTarget -> TypeRep -> [[Word8]]
findAnnsByTypeRep AnnEnv
epsHptAnns CoreAnnTarget
name TypeRep
tyrep
       ; let selectedTcgAnns :: [[Word8]]
selectedTcgAnns = AnnEnv -> CoreAnnTarget -> TypeRep -> [[Word8]]
findAnnsByTypeRep (TcGblEnv -> AnnEnv
tcg_ann_env TcGblEnv
tcg) CoreAnnTarget
name TypeRep
tyrep
       ; forall (m :: * -> *) a. Monad m => a -> m a
return ([[Word8]]
selectedEpsHptAnns forall a. [a] -> [a] -> [a]
++ [[Word8]]
selectedTcgAnns) }

{-
************************************************************************
*                                                                      *
            Instance Testing
*                                                                      *
************************************************************************
-}

reifyInstances :: TH.Name -> [TH.Type] -> TcM [TH.Dec]
reifyInstances :: Name -> [Type] -> TcM [Dec]
reifyInstances Name
th_nm [Type]
th_tys
  = do { Either (Class, [ClsInst]) (TyCon, [FamInst])
insts <- Name
-> [Type] -> TcM (Either (Class, [ClsInst]) (TyCon, [FamInst]))
reifyInstances' Name
th_nm [Type]
th_tys
       ; case Either (Class, [ClsInst]) (TyCon, [FamInst])
insts of
           Left (Class
cls, [ClsInst]
cls_insts) ->
             Class -> [ClsInst] -> TcM [Dec]
reifyClassInstances Class
cls [ClsInst]
cls_insts
           Right (TyCon
tc, [FamInst]
fam_insts) ->
             TyCon -> [FamInst] -> TcM [Dec]
reifyFamilyInstances TyCon
tc [FamInst]
fam_insts }

reifyInstances' :: TH.Name
                -> [TH.Type]
                -> TcM (Either (Class, [ClsInst]) (TyCon, [FamInst]))
                -- ^ Returns 'Left' in the case that the instances were found to
                -- be class instances, or 'Right' if they are family instances.
reifyInstances' :: Name
-> [Type] -> TcM (Either (Class, [ClsInst]) (TyCon, [FamInst]))
reifyInstances' Name
th_nm [Type]
th_tys
   = forall a. SDoc -> TcM a -> TcM a
addErrCtxt (String -> SDoc
text String
"In the argument of reifyInstances:"
                 SDoc -> SDoc -> SDoc
<+> forall a. Ppr a => a -> SDoc
ppr_th Name
th_nm SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
sep (forall a b. (a -> b) -> [a] -> [b]
map forall a. Ppr a => a -> SDoc
ppr_th [Type]
th_tys)) forall a b. (a -> b) -> a -> b
$
     do { SrcSpan
loc <- TcRn SrcSpan
getSrcSpanM
        ; Origin
th_origin <- TcM Origin
getThSpliceOrigin
        ; GenLocated SrcSpanAnnA (HsType GhcPs)
rdr_ty <- Origin -> SrcSpan -> Type -> TcM (LHsType GhcPs)
cvt Origin
th_origin SrcSpan
loc (Type -> [Type] -> Type
mkThAppTs (Name -> Type
TH.ConT Name
th_nm) [Type]
th_tys)
          -- #9262 says to bring vars into scope, like in HsForAllTy case
          -- of rnHsTyKi
        ; let tv_rdrs :: FreeKiTyVars
tv_rdrs = LHsType GhcPs -> FreeKiTyVars
extractHsTyRdrTyVars GenLocated SrcSpanAnnA (HsType GhcPs)
rdr_ty
          -- Rename  to HsType Name
        ; (([Name]
tv_names, GenLocated SrcSpanAnnA (HsType GhcRn)
rn_ty), FreeVars
_fvs)
            <- forall r. TcM r -> TcM r
checkNoErrs forall a b. (a -> b) -> a -> b
$ -- If there are out-of-scope Names here, then we
                             -- must error before proceeding to typecheck the
                             -- renamed type, as that will result in GHC
                             -- internal errors (#13837).
               forall assoc a.
Maybe assoc
-> FreeKiTyVars
-> ([Name] -> RnM (a, FreeVars))
-> RnM (a, FreeVars)
rnImplicitTvOccs forall a. Maybe a
Nothing FreeKiTyVars
tv_rdrs forall a b. (a -> b) -> a -> b
$ \ [Name]
tv_names ->
               do { (GenLocated SrcSpanAnnA (HsType GhcRn)
rn_ty, FreeVars
fvs) <- HsDocContext -> LHsType GhcPs -> RnM (LHsType GhcRn, FreeVars)
rnLHsType HsDocContext
doc GenLocated SrcSpanAnnA (HsType GhcPs)
rdr_ty
                  ; forall (m :: * -> *) a. Monad m => a -> m a
return (([Name]
tv_names, GenLocated SrcSpanAnnA (HsType GhcRn)
rn_ty), FreeVars
fvs) }

        ; (TcLevel
tclvl, WantedConstraints
wanted, ([Id]
tvs, Type
ty))
            <- forall a. String -> TcM a -> TcM (TcLevel, WantedConstraints, a)
pushLevelAndSolveEqualitiesX String
"reifyInstances"  forall a b. (a -> b) -> a -> b
$
               forall a. [Name] -> TcM a -> TcM ([Id], a)
bindImplicitTKBndrs_Skol [Name]
tv_names              forall a b. (a -> b) -> a -> b
$
               LHsType GhcRn -> IOEnv (Env TcGblEnv TcLclEnv) Type
tcInferLHsType GenLocated SrcSpanAnnA (HsType GhcRn)
rn_ty

        ; [Id]
tvs <- [Id] -> TcM [Id]
zonkAndScopedSort [Id]
tvs

        -- Avoid error cascade if there are unsolved
        ; SkolemInfo -> [Id] -> TcLevel -> WantedConstraints -> TcRn ()
reportUnsolvedEqualities SkolemInfo
ReifySkol [Id]
tvs TcLevel
tclvl WantedConstraints
wanted

        ; Type
ty <- Type -> IOEnv (Env TcGblEnv TcLclEnv) Type
zonkTcTypeToType Type
ty
                -- Substitute out the meta type variables
                -- In particular, the type might have kind
                -- variables inside it (#7477)

        ; String -> SDoc -> TcRn ()
traceTc String
"reifyInstances'" (forall a. Outputable a => a -> SDoc
ppr Type
ty SDoc -> SDoc -> SDoc
$$ forall a. Outputable a => a -> SDoc
ppr (HasDebugCallStack => Type -> Type
tcTypeKind Type
ty))
        ; case HasDebugCallStack => Type -> Maybe (TyCon, [Type])
splitTyConApp_maybe Type
ty of   -- This expands any type synonyms
            Just (TyCon
tc, [Type]
tys)                 -- See #7910
               | Just Class
cls <- TyCon -> Maybe Class
tyConClass_maybe TyCon
tc
               -> do { InstEnvs
inst_envs <- TcM InstEnvs
tcGetInstEnvs
                     ; let ([InstMatch]
matches, [ClsInst]
unifies, [InstMatch]
_) = Bool
-> InstEnvs
-> Class
-> [Type]
-> ([InstMatch], [ClsInst], [InstMatch])
lookupInstEnv Bool
False InstEnvs
inst_envs Class
cls [Type]
tys
                     ; String -> SDoc -> TcRn ()
traceTc String
"reifyInstances'1" (forall a. Outputable a => a -> SDoc
ppr [InstMatch]
matches)
                     ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a b. a -> Either a b
Left (Class
cls, forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> a
fst [InstMatch]
matches forall a. [a] -> [a] -> [a]
++ [ClsInst]
unifies) }
               | TyCon -> Bool
isOpenFamilyTyCon TyCon
tc
               -> do { FamInstEnvs
inst_envs <- TcM FamInstEnvs
tcGetFamInstEnvs
                     ; let matches :: [FamInstMatch]
matches = FamInstEnvs -> TyCon -> [Type] -> [FamInstMatch]
lookupFamInstEnv FamInstEnvs
inst_envs TyCon
tc [Type]
tys
                     ; String -> SDoc -> TcRn ()
traceTc String
"reifyInstances'2" (forall a. Outputable a => a -> SDoc
ppr [FamInstMatch]
matches)
                     ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a b. b -> Either a b
Right (TyCon
tc, forall a b. (a -> b) -> [a] -> [b]
map FamInstMatch -> FamInst
fim_instance [FamInstMatch]
matches) }
            Maybe (TyCon, [Type])
_  -> forall a. SDoc -> TcM a
bale_out (SDoc -> SumArity -> SDoc -> SDoc
hang (String -> SDoc
text String
"reifyInstances:" SDoc -> SDoc -> SDoc
<+> SDoc -> SDoc
quotes (forall a. Outputable a => a -> SDoc
ppr Type
ty))
                               SumArity
2 (String -> SDoc
text String
"is not a class constraint or type family application")) }
  where
    doc :: HsDocContext
doc = HsDocContext
ClassInstanceCtx
    bale_out :: SDoc -> TcM a
bale_out SDoc
msg = forall a. SDoc -> TcM a
failWithTc SDoc
msg

    cvt :: Origin -> SrcSpan -> TH.Type -> TcM (LHsType GhcPs)
    cvt :: Origin -> SrcSpan -> Type -> TcM (LHsType GhcPs)
cvt Origin
origin SrcSpan
loc Type
th_ty = case Origin -> SrcSpan -> Type -> Either SDoc (LHsType GhcPs)
convertToHsType Origin
origin SrcSpan
loc Type
th_ty of
      Left SDoc
msg -> forall a. SDoc -> TcM a
failWithTc SDoc
msg
      Right LHsType GhcPs
ty -> forall (m :: * -> *) a. Monad m => a -> m a
return LHsType GhcPs
ty

{-
************************************************************************
*                                                                      *
                        Reification
*                                                                      *
************************************************************************
-}

lookupName :: Bool      -- True  <=> type namespace
                        -- False <=> value namespace
           -> String -> TcM (Maybe TH.Name)
lookupName :: Bool -> String -> TcM (Maybe Name)
lookupName Bool
is_type_name String
s
  = do { Maybe Name
mb_nm <- RdrName -> RnM (Maybe Name)
lookupOccRn_maybe RdrName
rdr_name
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall n. NamedThing n => n -> Name
reifyName Maybe Name
mb_nm) }
  where
    th_name :: Name
th_name = String -> Name
TH.mkName String
s       -- Parses M.x into a base of 'x' and a module of 'M'

    occ_fs :: FastString
    occ_fs :: FastString
occ_fs = String -> FastString
mkFastString (Name -> String
TH.nameBase Name
th_name)

    occ :: OccName
    occ :: OccName
occ | Bool
is_type_name
        = if FastString -> Bool
isLexVarSym FastString
occ_fs Bool -> Bool -> Bool
|| FastString -> Bool
isLexCon FastString
occ_fs
                             then FastString -> OccName
mkTcOccFS    FastString
occ_fs
                             else FastString -> OccName
mkTyVarOccFS FastString
occ_fs
        | Bool
otherwise
        = if FastString -> Bool
isLexCon FastString
occ_fs then FastString -> OccName
mkDataOccFS FastString
occ_fs
                             else FastString -> OccName
mkVarOccFS  FastString
occ_fs

    rdr_name :: RdrName
rdr_name = case Name -> Maybe String
TH.nameModule Name
th_name of
                 Maybe String
Nothing  -> OccName -> RdrName
mkRdrUnqual OccName
occ
                 Just String
mod -> ModuleName -> OccName -> RdrName
mkRdrQual (String -> ModuleName
mkModuleName String
mod) OccName
occ

getThing :: TH.Name -> TcM TcTyThing
getThing :: Name -> TcM TcTyThing
getThing Name
th_name
  = do  { Name
name <- Name -> TcM Name
lookupThName Name
th_name
        ; forall m n. SDoc -> TcRnIf m n ()
traceIf (String -> SDoc
text String
"reify" SDoc -> SDoc -> SDoc
<+> String -> SDoc
text (forall a. Show a => a -> String
show Name
th_name) SDoc -> SDoc -> SDoc
<+> SDoc -> SDoc
brackets (Name -> SDoc
ppr_ns Name
th_name) SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr Name
name)
        ; Name -> TcM TcTyThing
tcLookupTh Name
name }
        -- ToDo: this tcLookup could fail, which would give a
        --       rather unhelpful error message
  where
    ppr_ns :: Name -> SDoc
ppr_ns (TH.Name OccName
_ (TH.NameG NameSpace
TH.DataName  PkgName
_pkg ModName
_mod)) = String -> SDoc
text String
"data"
    ppr_ns (TH.Name OccName
_ (TH.NameG NameSpace
TH.TcClsName PkgName
_pkg ModName
_mod)) = String -> SDoc
text String
"tc"
    ppr_ns (TH.Name OccName
_ (TH.NameG NameSpace
TH.VarName   PkgName
_pkg ModName
_mod)) = String -> SDoc
text String
"var"
    ppr_ns Name
_ = forall a. String -> a
panic String
"reify/ppr_ns"

reify :: TH.Name -> TcM TH.Info
reify :: Name -> TcM Info
reify Name
th_name
  = do  { String -> SDoc -> TcRn ()
traceTc String
"reify 1" (String -> SDoc
text (Name -> String
TH.showName Name
th_name))
        ; TcTyThing
thing <- Name -> TcM TcTyThing
getThing Name
th_name
        ; String -> SDoc -> TcRn ()
traceTc String
"reify 2" (forall a. Outputable a => a -> SDoc
ppr TcTyThing
thing)
        ; TcTyThing -> TcM Info
reifyThing TcTyThing
thing }

lookupThName :: TH.Name -> TcM Name
lookupThName :: Name -> TcM Name
lookupThName Name
th_name = do
    Maybe Name
mb_name <- Name -> RnM (Maybe Name)
lookupThName_maybe Name
th_name
    case Maybe Name
mb_name of
        Maybe Name
Nothing   -> forall a. SDoc -> TcM a
failWithTc (Name -> SDoc
notInScope Name
th_name)
        Just Name
name -> forall (m :: * -> *) a. Monad m => a -> m a
return Name
name

lookupThName_maybe :: TH.Name -> TcM (Maybe Name)
lookupThName_maybe :: Name -> RnM (Maybe Name)
lookupThName_maybe Name
th_name
  =  do { [Name]
names <- forall (m :: * -> *) a b.
Applicative m =>
(a -> m (Maybe b)) -> [a] -> m [b]
mapMaybeM RdrName -> RnM (Maybe Name)
lookupOccRn_maybe (Name -> [RdrName]
thRdrNameGuesses Name
th_name)
          -- Pick the first that works
          -- E.g. reify (mkName "A") will pick the class A in preference to the data constructor A
        ; forall (m :: * -> *) a. Monad m => a -> m a
return (forall a. [a] -> Maybe a
listToMaybe [Name]
names) }

tcLookupTh :: Name -> TcM TcTyThing
-- This is a specialised version of GHC.Tc.Utils.Env.tcLookup; specialised mainly in that
-- it gives a reify-related error message on failure, whereas in the normal
-- tcLookup, failure is a bug.
tcLookupTh :: Name -> TcM TcTyThing
tcLookupTh Name
name
  = do  { (TcGblEnv
gbl_env, TcLclEnv
lcl_env) <- forall gbl lcl. TcRnIf gbl lcl (gbl, lcl)
getEnvs
        ; case forall a. NameEnv a -> Name -> Maybe a
lookupNameEnv (TcLclEnv -> TcTypeEnv
tcl_env TcLclEnv
lcl_env) Name
name of {
                Just TcTyThing
thing -> forall (m :: * -> *) a. Monad m => a -> m a
return TcTyThing
thing;
                Maybe TcTyThing
Nothing    ->

          case forall a. NameEnv a -> Name -> Maybe a
lookupNameEnv (TcGblEnv -> TypeEnv
tcg_type_env TcGblEnv
gbl_env) Name
name of {
                Just TyThing
thing -> forall (m :: * -> *) a. Monad m => a -> m a
return (TyThing -> TcTyThing
AGlobal TyThing
thing);
                Maybe TyThing
Nothing    ->

          -- EZY: I don't think this choice matters, no TH in signatures!
          if GenModule Unit -> Name -> Bool
nameIsLocalOrFrom (TcGblEnv -> GenModule Unit
tcg_semantic_mod TcGblEnv
gbl_env) Name
name
          then  -- It's defined in this module
                forall a. SDoc -> TcM a
failWithTc (Name -> SDoc
notInEnv Name
name)

          else
     do { MaybeErr SDoc TyThing
mb_thing <- Name -> TcM (MaybeErr SDoc TyThing)
tcLookupImported_maybe Name
name
        ; case MaybeErr SDoc TyThing
mb_thing of
            Succeeded TyThing
thing -> forall (m :: * -> *) a. Monad m => a -> m a
return (TyThing -> TcTyThing
AGlobal TyThing
thing)
            Failed SDoc
msg      -> forall a. SDoc -> TcM a
failWithTc SDoc
msg
    }}}}

notInScope :: TH.Name -> SDoc
notInScope :: Name -> SDoc
notInScope Name
th_name = SDoc -> SDoc
quotes (String -> SDoc
text (forall a. Ppr a => a -> String
TH.pprint Name
th_name)) SDoc -> SDoc -> SDoc
<+>
                     String -> SDoc
text String
"is not in scope at a reify"
        -- Ugh! Rather an indirect way to display the name

notInEnv :: Name -> SDoc
notInEnv :: Name -> SDoc
notInEnv Name
name = SDoc -> SDoc
quotes (forall a. Outputable a => a -> SDoc
ppr Name
name) SDoc -> SDoc -> SDoc
<+>
                     String -> SDoc
text String
"is not in the type environment at a reify"

------------------------------
reifyRoles :: TH.Name -> TcM [TH.Role]
reifyRoles :: Name -> TcM [Role]
reifyRoles Name
th_name
  = do { TcTyThing
thing <- Name -> TcM TcTyThing
getThing Name
th_name
       ; case TcTyThing
thing of
           AGlobal (ATyCon TyCon
tc) -> forall (m :: * -> *) a. Monad m => a -> m a
return (forall a b. (a -> b) -> [a] -> [b]
map Role -> Role
reify_role (TyCon -> [Role]
tyConRoles TyCon
tc))
           TcTyThing
_ -> forall a. SDoc -> TcM a
failWithTc (String -> SDoc
text String
"No roles associated with" SDoc -> SDoc -> SDoc
<+> (forall a. Outputable a => a -> SDoc
ppr TcTyThing
thing))
       }
  where
    reify_role :: Role -> Role
reify_role Role
Nominal          = Role
TH.NominalR
    reify_role Role
Representational = Role
TH.RepresentationalR
    reify_role Role
Phantom          = Role
TH.PhantomR

------------------------------
reifyThing :: TcTyThing -> TcM TH.Info
-- The only reason this is monadic is for error reporting,
-- which in turn is mainly for the case when TH can't express
-- some random GHC extension

reifyThing :: TcTyThing -> TcM Info
reifyThing (AGlobal (AnId Id
id))
  = do  { Type
ty <- Type -> TcM Type
reifyType (Id -> Type
idType Id
id)
        ; let v :: Name
v = forall n. NamedThing n => n -> Name
reifyName Id
id
        ; case Id -> IdDetails
idDetails Id
id of
            ClassOpId Class
cls -> forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> Type -> Name -> Info
TH.ClassOpI Name
v Type
ty (forall n. NamedThing n => n -> Name
reifyName Class
cls))
            RecSelId{sel_tycon :: IdDetails -> RecSelParent
sel_tycon=RecSelData TyCon
tc}
                          -> forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> Type -> Maybe Dec -> Info
TH.VarI (Id -> TyCon -> Name
reifySelector Id
id TyCon
tc) Type
ty forall a. Maybe a
Nothing)
            IdDetails
_             -> forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> Type -> Maybe Dec -> Info
TH.VarI     Name
v Type
ty forall a. Maybe a
Nothing)
    }

reifyThing (AGlobal (ATyCon TyCon
tc))   = TyCon -> TcM Info
reifyTyCon TyCon
tc
reifyThing (AGlobal (AConLike (RealDataCon DataCon
dc)))
  = do  { let name :: Name
name = DataCon -> Name
dataConName DataCon
dc
        ; Type
ty <- Type -> TcM Type
reifyType (Id -> Type
idType (DataCon -> Id
dataConWrapId DataCon
dc))
        ; forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> Type -> Name -> Info
TH.DataConI (forall n. NamedThing n => n -> Name
reifyName Name
name) Type
ty
                              (forall n. NamedThing n => n -> Name
reifyName (DataCon -> TyCon
dataConOrigTyCon DataCon
dc)))
        }

reifyThing (AGlobal (AConLike (PatSynCon PatSyn
ps)))
  = do { let name :: Name
name = forall n. NamedThing n => n -> Name
reifyName PatSyn
ps
       ; Type
ty <- ([InvisTVBinder], [Type], [InvisTVBinder], [Type], [Scaled Type],
 Type)
-> TcM Type
reifyPatSynType (PatSyn
-> ([InvisTVBinder], [Type], [InvisTVBinder], [Type],
    [Scaled Type], Type)
patSynSigBndr PatSyn
ps)
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> Type -> Info
TH.PatSynI Name
name Type
ty) }

reifyThing (ATcId {tct_id :: TcTyThing -> Id
tct_id = Id
id})
  = do  { Type
ty1 <- Type -> IOEnv (Env TcGblEnv TcLclEnv) Type
zonkTcType (Id -> Type
idType Id
id) -- Make use of all the info we have, even
                                        -- though it may be incomplete
        ; Type
ty2 <- Type -> TcM Type
reifyType Type
ty1
        ; forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> Type -> Maybe Dec -> Info
TH.VarI (forall n. NamedThing n => n -> Name
reifyName Id
id) Type
ty2 forall a. Maybe a
Nothing) }

reifyThing (ATyVar Name
tv Id
tv1)
  = do { Type
ty1 <- Id -> IOEnv (Env TcGblEnv TcLclEnv) Type
zonkTcTyVar Id
tv1
       ; Type
ty2 <- Type -> TcM Type
reifyType Type
ty1
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> Type -> Info
TH.TyVarI (forall n. NamedThing n => n -> Name
reifyName Name
tv) Type
ty2) }

reifyThing TcTyThing
thing = forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"reifyThing" (TcTyThing -> SDoc
pprTcTyThingCategory TcTyThing
thing)

-------------------------------------------
reifyAxBranch :: TyCon -> CoAxBranch -> TcM TH.TySynEqn
reifyAxBranch :: TyCon -> CoAxBranch -> TcM TySynEqn
reifyAxBranch TyCon
fam_tc (CoAxBranch { cab_tvs :: CoAxBranch -> [Id]
cab_tvs = [Id]
tvs
                                 , cab_lhs :: CoAxBranch -> [Type]
cab_lhs = [Type]
lhs
                                 , cab_rhs :: CoAxBranch -> Type
cab_rhs = Type
rhs })
            -- remove kind patterns (#8884)
  = do { Maybe [TyVarBndr ()]
tvs' <- [Id] -> TcM (Maybe [TyVarBndr ()])
reifyTyVarsToMaybe [Id]
tvs
       ; let lhs_types_only :: [Type]
lhs_types_only = TyCon -> [Type] -> [Type]
filterOutInvisibleTypes TyCon
fam_tc [Type]
lhs
       ; [Type]
lhs' <- [Type] -> TcM [Type]
reifyTypes [Type]
lhs_types_only
       ; [Type]
annot_th_lhs <- forall (m :: * -> *) a b c d.
Monad m =>
(a -> b -> c -> m d) -> [a] -> [b] -> [c] -> m [d]
zipWith3M Bool -> Type -> Type -> TcM Type
annotThType (TyCon -> [Bool]
tyConArgsPolyKinded TyCon
fam_tc)
                                   [Type]
lhs_types_only [Type]
lhs'
       ; let lhs_type :: Type
lhs_type = Type -> [Type] -> Type
mkThAppTs (Name -> Type
TH.ConT forall a b. (a -> b) -> a -> b
$ forall n. NamedThing n => n -> Name
reifyName TyCon
fam_tc) [Type]
annot_th_lhs
       ; Type
rhs'  <- Type -> TcM Type
reifyType Type
rhs
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (Maybe [TyVarBndr ()] -> Type -> Type -> TySynEqn
TH.TySynEqn Maybe [TyVarBndr ()]
tvs' Type
lhs_type Type
rhs') }

reifyTyCon :: TyCon -> TcM TH.Info
reifyTyCon :: TyCon -> TcM Info
reifyTyCon TyCon
tc
  | Just Class
cls <- TyCon -> Maybe Class
tyConClass_maybe TyCon
tc
  = Class -> TcM Info
reifyClass Class
cls

  | TyCon -> Bool
isFunTyCon TyCon
tc
  = forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> SumArity -> Bool -> Info
TH.PrimTyConI (forall n. NamedThing n => n -> Name
reifyName TyCon
tc) SumArity
2                Bool
False)

  | TyCon -> Bool
isPrimTyCon TyCon
tc
  = forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> SumArity -> Bool -> Info
TH.PrimTyConI (forall n. NamedThing n => n -> Name
reifyName TyCon
tc) (forall (t :: * -> *) a. Foldable t => t a -> SumArity
length (TyCon -> [Id]
tyConVisibleTyVars TyCon
tc))
                          (TyCon -> Bool
isUnliftedTyCon TyCon
tc))

  | TyCon -> Bool
isTypeFamilyTyCon TyCon
tc
  = do { let tvs :: [Id]
tvs      = TyCon -> [Id]
tyConTyVars TyCon
tc
             res_kind :: Type
res_kind = TyCon -> Type
tyConResKind TyCon
tc
             resVar :: Maybe Name
resVar   = TyCon -> Maybe Name
famTcResVar TyCon
tc

       ; Type
kind' <- Type -> TcM Type
reifyKind Type
res_kind
       ; let (FamilyResultSig
resultSig, Maybe InjectivityAnn
injectivity) =
                 case Maybe Name
resVar of
                   Maybe Name
Nothing   -> (Type -> FamilyResultSig
TH.KindSig Type
kind', forall a. Maybe a
Nothing)
                   Just Name
name ->
                     let thName :: Name
thName   = forall n. NamedThing n => n -> Name
reifyName Name
name
                         injAnnot :: Injectivity
injAnnot = TyCon -> Injectivity
tyConInjectivityInfo TyCon
tc
                         sig :: FamilyResultSig
sig = TyVarBndr () -> FamilyResultSig
TH.TyVarSig (forall flag. Name -> flag -> Type -> TyVarBndr flag
TH.KindedTV Name
thName () Type
kind')
                         inj :: Maybe InjectivityAnn
inj = case Injectivity
injAnnot of
                                 Injectivity
NotInjective -> forall a. Maybe a
Nothing
                                 Injective [Bool]
ms ->
                                     forall a. a -> Maybe a
Just (Name -> [Name] -> InjectivityAnn
TH.InjectivityAnn Name
thName [Name]
injRHS)
                                   where
                                     injRHS :: [Name]
injRHS = forall a b. (a -> b) -> [a] -> [b]
map (forall n. NamedThing n => n -> Name
reifyName forall b c a. (b -> c) -> (a -> b) -> a -> c
. Id -> Name
tyVarName)
                                                  (forall a. [Bool] -> [a] -> [a]
filterByList [Bool]
ms [Id]
tvs)
                     in (FamilyResultSig
sig, Maybe InjectivityAnn
inj)
       ; [TyVarBndr ()]
tvs' <- [Id] -> TcM [TyVarBndr ()]
reifyTyVars (TyCon -> [Id]
tyConVisibleTyVars TyCon
tc)
       ; let tfHead :: TypeFamilyHead
tfHead =
               Name
-> [TyVarBndr ()]
-> FamilyResultSig
-> Maybe InjectivityAnn
-> TypeFamilyHead
TH.TypeFamilyHead (forall n. NamedThing n => n -> Name
reifyName TyCon
tc) [TyVarBndr ()]
tvs' FamilyResultSig
resultSig Maybe InjectivityAnn
injectivity
       ; if TyCon -> Bool
isOpenTypeFamilyTyCon TyCon
tc
         then do { FamInstEnvs
fam_envs <- TcM FamInstEnvs
tcGetFamInstEnvs
                 ; [Dec]
instances <- TyCon -> [FamInst] -> TcM [Dec]
reifyFamilyInstances TyCon
tc
                                  (FamInstEnvs -> TyCon -> [FamInst]
familyInstances FamInstEnvs
fam_envs TyCon
tc)
                 ; forall (m :: * -> *) a. Monad m => a -> m a
return (Dec -> [Dec] -> Info
TH.FamilyI (TypeFamilyHead -> Dec
TH.OpenTypeFamilyD TypeFamilyHead
tfHead) [Dec]
instances) }
         else do { [TySynEqn]
eqns <-
                     case TyCon -> Maybe (CoAxiom Branched)
isClosedSynFamilyTyConWithAxiom_maybe TyCon
tc of
                       Just CoAxiom Branched
ax -> forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (TyCon -> CoAxBranch -> TcM TySynEqn
reifyAxBranch TyCon
tc) forall a b. (a -> b) -> a -> b
$
                                  forall (br :: BranchFlag). Branches br -> [CoAxBranch]
fromBranches forall a b. (a -> b) -> a -> b
$ forall (br :: BranchFlag). CoAxiom br -> Branches br
coAxiomBranches CoAxiom Branched
ax
                       Maybe (CoAxiom Branched)
Nothing -> forall (m :: * -> *) a. Monad m => a -> m a
return []
                 ; forall (m :: * -> *) a. Monad m => a -> m a
return (Dec -> [Dec] -> Info
TH.FamilyI (TypeFamilyHead -> [TySynEqn] -> Dec
TH.ClosedTypeFamilyD TypeFamilyHead
tfHead [TySynEqn]
eqns)
                      []) } }

  | TyCon -> Bool
isDataFamilyTyCon TyCon
tc
  = do { let res_kind :: Type
res_kind = TyCon -> Type
tyConResKind TyCon
tc

       ; Maybe Type
kind' <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall a. a -> Maybe a
Just (Type -> TcM Type
reifyKind Type
res_kind)

       ; [TyVarBndr ()]
tvs' <- [Id] -> TcM [TyVarBndr ()]
reifyTyVars (TyCon -> [Id]
tyConVisibleTyVars TyCon
tc)
       ; FamInstEnvs
fam_envs <- TcM FamInstEnvs
tcGetFamInstEnvs
       ; [Dec]
instances <- TyCon -> [FamInst] -> TcM [Dec]
reifyFamilyInstances TyCon
tc (FamInstEnvs -> TyCon -> [FamInst]
familyInstances FamInstEnvs
fam_envs TyCon
tc)
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (Dec -> [Dec] -> Info
TH.FamilyI
                       (Name -> [TyVarBndr ()] -> Maybe Type -> Dec
TH.DataFamilyD (forall n. NamedThing n => n -> Name
reifyName TyCon
tc) [TyVarBndr ()]
tvs' Maybe Type
kind') [Dec]
instances) }

  | Just ([Id]
_, Type
rhs) <- TyCon -> Maybe ([Id], Type)
synTyConDefn_maybe TyCon
tc  -- Vanilla type synonym
  = do { Type
rhs' <- Type -> TcM Type
reifyType Type
rhs
       ; [TyVarBndr ()]
tvs' <- [Id] -> TcM [TyVarBndr ()]
reifyTyVars (TyCon -> [Id]
tyConVisibleTyVars TyCon
tc)
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (Dec -> Info
TH.TyConI
                   (Name -> [TyVarBndr ()] -> Type -> Dec
TH.TySynD (forall n. NamedThing n => n -> Name
reifyName TyCon
tc) [TyVarBndr ()]
tvs' Type
rhs'))
       }

  | Bool
otherwise
  = do  { [Type]
cxt <- [Type] -> TcM [Type]
reifyCxt (TyCon -> [Type]
tyConStupidTheta TyCon
tc)
        ; let tvs :: [Id]
tvs      = TyCon -> [Id]
tyConTyVars TyCon
tc
              dataCons :: [DataCon]
dataCons = TyCon -> [DataCon]
tyConDataCons TyCon
tc
              isGadt :: Bool
isGadt   = TyCon -> Bool
isGadtSyntaxTyCon TyCon
tc
        ; [Con]
cons <- forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (Bool -> [Type] -> DataCon -> TcM Con
reifyDataCon Bool
isGadt ([Id] -> [Type]
mkTyVarTys [Id]
tvs)) [DataCon]
dataCons
        ; [TyVarBndr ()]
r_tvs <- [Id] -> TcM [TyVarBndr ()]
reifyTyVars (TyCon -> [Id]
tyConVisibleTyVars TyCon
tc)
        ; let name :: Name
name = forall n. NamedThing n => n -> Name
reifyName TyCon
tc
              deriv :: [a]
deriv = []        -- Don't know about deriving
              decl :: Dec
decl | TyCon -> Bool
isNewTyCon TyCon
tc =
                       [Type]
-> Name
-> [TyVarBndr ()]
-> Maybe Type
-> Con
-> [DerivClause]
-> Dec
TH.NewtypeD [Type]
cxt Name
name [TyVarBndr ()]
r_tvs forall a. Maybe a
Nothing (forall a. [a] -> a
head [Con]
cons) forall a. [a]
deriv
                   | Bool
otherwise     =
                       [Type]
-> Name
-> [TyVarBndr ()]
-> Maybe Type
-> [Con]
-> [DerivClause]
-> Dec
TH.DataD    [Type]
cxt Name
name [TyVarBndr ()]
r_tvs forall a. Maybe a
Nothing       [Con]
cons  forall a. [a]
deriv
        ; forall (m :: * -> *) a. Monad m => a -> m a
return (Dec -> Info
TH.TyConI Dec
decl) }

reifyDataCon :: Bool -> [Type] -> DataCon -> TcM TH.Con
reifyDataCon :: Bool -> [Type] -> DataCon -> TcM Con
reifyDataCon Bool
isGadtDataCon [Type]
tys DataCon
dc
  = do { let -- used for H98 data constructors
             ([Id]
ex_tvs, [Type]
theta, [Type]
arg_tys)
                 = DataCon -> [Type] -> ([Id], [Type], [Type])
dataConInstSig DataCon
dc [Type]
tys
             -- used for GADTs data constructors
             g_user_tvs' :: [InvisTVBinder]
g_user_tvs' = DataCon -> [InvisTVBinder]
dataConUserTyVarBinders DataCon
dc
             ([Id]
g_univ_tvs, [Id]
_, [EqSpec]
g_eq_spec, [Type]
g_theta', [Scaled Type]
g_arg_tys', Type
g_res_ty')
                 = DataCon -> ([Id], [Id], [EqSpec], [Type], [Scaled Type], Type)
dataConFullSig DataCon
dc
             ([SourceUnpackedness]
srcUnpks, [SourceStrictness]
srcStricts)
                 = forall a b c. (a -> (b, c)) -> [a] -> ([b], [c])
mapAndUnzip HsSrcBang -> (SourceUnpackedness, SourceStrictness)
reifySourceBang (DataCon -> [HsSrcBang]
dataConSrcBangs DataCon
dc)
             dcdBangs :: [Bang]
dcdBangs  = forall a b c. (a -> b -> c) -> [a] -> [b] -> [c]
zipWith SourceUnpackedness -> SourceStrictness -> Bang
TH.Bang [SourceUnpackedness]
srcUnpks [SourceStrictness]
srcStricts
             fields :: [FieldLabel]
fields    = DataCon -> [FieldLabel]
dataConFieldLabels DataCon
dc
             name :: Name
name      = forall n. NamedThing n => n -> Name
reifyName DataCon
dc
             -- Universal tvs present in eq_spec need to be filtered out, as
             -- they will not appear anywhere in the type.
             eq_spec_tvs :: VarSet
eq_spec_tvs = [Id] -> VarSet
mkVarSet (forall a b. (a -> b) -> [a] -> [b]
map EqSpec -> Id
eqSpecTyVar [EqSpec]
g_eq_spec)

       ; (TCvSubst
univ_subst, [Id]
_)
              -- See Note [Freshen reified GADT constructors' universal tyvars]
           <- [Id] -> TcM (TCvSubst, [Id])
freshenTyVarBndrs forall a b. (a -> b) -> a -> b
$
              forall a. (a -> Bool) -> [a] -> [a]
filterOut (Id -> VarSet -> Bool
`elemVarSet` VarSet
eq_spec_tvs) [Id]
g_univ_tvs
       ; let (TCvSubst
tvb_subst, [InvisTVBinder]
g_user_tvs) = forall {argf}.
TCvSubst -> [VarBndr Id argf] -> (TCvSubst, [VarBndr Id argf])
subst_tv_binders TCvSubst
univ_subst [InvisTVBinder]
g_user_tvs'
             g_theta :: [Type]
g_theta   = HasCallStack => TCvSubst -> [Type] -> [Type]
substTys TCvSubst
tvb_subst [Type]
g_theta'
             g_arg_tys :: [Type]
g_arg_tys = HasCallStack => TCvSubst -> [Type] -> [Type]
substTys TCvSubst
tvb_subst (forall a b. (a -> b) -> [a] -> [b]
map forall a. Scaled a -> a
scaledThing [Scaled Type]
g_arg_tys')
             g_res_ty :: Type
g_res_ty  = HasCallStack => TCvSubst -> Type -> Type
substTy  TCvSubst
tvb_subst Type
g_res_ty'

       ; [Type]
r_arg_tys <- [Type] -> TcM [Type]
reifyTypes (if Bool
isGadtDataCon then [Type]
g_arg_tys else [Type]
arg_tys)

       ; Con
main_con <-
           if | Bool -> Bool
not (forall (t :: * -> *) a. Foldable t => t a -> Bool
null [FieldLabel]
fields) Bool -> Bool -> Bool
&& Bool -> Bool
not Bool
isGadtDataCon ->
                  forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ Name -> [VarBangType] -> Con
TH.RecC Name
name (forall a b c. [a] -> [b] -> [c] -> [(a, b, c)]
zip3 (forall a b. (a -> b) -> [a] -> [b]
map FieldLabel -> Name
reifyFieldLabel [FieldLabel]
fields)
                                         [Bang]
dcdBangs [Type]
r_arg_tys)
              | Bool -> Bool
not (forall (t :: * -> *) a. Foldable t => t a -> Bool
null [FieldLabel]
fields) -> do
                  { Type
res_ty <- Type -> TcM Type
reifyType Type
g_res_ty
                  ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ [Name] -> [VarBangType] -> Type -> Con
TH.RecGadtC [Name
name]
                                     (forall a b c. [a] -> [b] -> [c] -> [(a, b, c)]
zip3 (forall a b. (a -> b) -> [a] -> [b]
map (forall n. NamedThing n => n -> Name
reifyName forall b c a. (b -> c) -> (a -> b) -> a -> c
. FieldLabel -> Name
flSelector) [FieldLabel]
fields)
                                      [Bang]
dcdBangs [Type]
r_arg_tys) Type
res_ty }
                -- We need to check not isGadtDataCon here because GADT
                -- constructors can be declared infix.
                -- See Note [Infix GADT constructors] in GHC.Tc.TyCl.
              | DataCon -> Bool
dataConIsInfix DataCon
dc Bool -> Bool -> Bool
&& Bool -> Bool
not Bool
isGadtDataCon ->
                  ASSERT( r_arg_tys `lengthIs` 2 ) do
                  { let [r_a1, r_a2] = r_arg_tys
                        [s1,   s2]   = dcdBangs
                  ; return $ TH.InfixC (s1,r_a1) name (s2,r_a2) }
              | Bool
isGadtDataCon -> do
                  { Type
res_ty <- Type -> TcM Type
reifyType Type
g_res_ty
                  ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ [Name] -> [BangType] -> Type -> Con
TH.GadtC [Name
name] ([Bang]
dcdBangs forall a b. [a] -> [b] -> [(a, b)]
`zip` [Type]
r_arg_tys) Type
res_ty }
              | Bool
otherwise ->
                  forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ Name -> [BangType] -> Con
TH.NormalC Name
name ([Bang]
dcdBangs forall a b. [a] -> [b] -> [(a, b)]
`zip` [Type]
r_arg_tys)

       ; let ([InvisTVBinder]
ex_tvs', [Type]
theta') | Bool
isGadtDataCon = ([InvisTVBinder]
g_user_tvs, [Type]
g_theta)
                               | Bool
otherwise     = ASSERT( all isTyVar ex_tvs )
                                                 -- no covars for haskell syntax
                                                 (forall a b. (a -> b) -> [a] -> [b]
map forall {var}. var -> VarBndr var Specificity
mk_specified [Id]
ex_tvs, [Type]
theta)
             ret_con :: TcM Con
ret_con | forall (t :: * -> *) a. Foldable t => t a -> Bool
null [InvisTVBinder]
ex_tvs' Bool -> Bool -> Bool
&& forall (t :: * -> *) a. Foldable t => t a -> Bool
null [Type]
theta' = forall (m :: * -> *) a. Monad m => a -> m a
return Con
main_con
                     | Bool
otherwise                   = do
                         { [Type]
cxt <- [Type] -> TcM [Type]
reifyCxt [Type]
theta'
                         ; [TyVarBndr Specificity]
ex_tvs'' <- forall flag flag'.
ReifyFlag flag flag' =>
[VarBndr Id flag] -> TcM [TyVarBndr flag']
reifyTyVarBndrs [InvisTVBinder]
ex_tvs'
                         ; forall (m :: * -> *) a. Monad m => a -> m a
return ([TyVarBndr Specificity] -> [Type] -> Con -> Con
TH.ForallC [TyVarBndr Specificity]
ex_tvs'' [Type]
cxt Con
main_con) }
       ; ASSERT( r_arg_tys `equalLength` dcdBangs )
         TcM Con
ret_con }
  where
    mk_specified :: var -> VarBndr var Specificity
mk_specified var
tv = forall var argf. var -> argf -> VarBndr var argf
Bndr var
tv Specificity
SpecifiedSpec

    subst_tv_binders :: TCvSubst -> [VarBndr Id argf] -> (TCvSubst, [VarBndr Id argf])
subst_tv_binders TCvSubst
subst [VarBndr Id argf]
tv_bndrs =
      let tvs :: [Id]
tvs            = forall tv argf. [VarBndr tv argf] -> [tv]
binderVars [VarBndr Id argf]
tv_bndrs
          flags :: [argf]
flags          = forall a b. (a -> b) -> [a] -> [b]
map forall tv argf. VarBndr tv argf -> argf
binderArgFlag [VarBndr Id argf]
tv_bndrs
          (TCvSubst
subst', [Id]
tvs') = HasCallStack => TCvSubst -> [Id] -> (TCvSubst, [Id])
substTyVarBndrs TCvSubst
subst [Id]
tvs
          tv_bndrs' :: [VarBndr Id argf]
tv_bndrs'      = forall a b. (a -> b) -> [a] -> [b]
map (\(Id
tv,argf
fl) -> forall var argf. var -> argf -> VarBndr var argf
Bndr Id
tv argf
fl) (forall a b. [a] -> [b] -> [(a, b)]
zip [Id]
tvs' [argf]
flags)
      in (TCvSubst
subst', [VarBndr Id argf]
tv_bndrs')

{-
Note [Freshen reified GADT constructors' universal tyvars]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Suppose one were to reify this GADT:

  data a :~: b where
    Refl :: forall a b. (a ~ b) => a :~: b

We ought to be careful here about the uniques we give to the occurrences of `a`
and `b` in this definition. That is because in the original DataCon, all uses
of `a` and `b` have the same unique, since `a` and `b` are both universally
quantified type variables--that is, they are used in both the (:~:) tycon as
well as in the constructor type signature. But when we turn the DataCon
definition into the reified one, the `a` and `b` in the constructor type
signature becomes differently scoped than the `a` and `b` in `data a :~: b`.

While it wouldn't technically be *wrong* per se to re-use the same uniques for
`a` and `b` across these two different scopes, it's somewhat annoying for end
users of Template Haskell, since they wouldn't be able to rely on the
assumption that all TH names have globally distinct uniques (#13885). For this
reason, we freshen the universally quantified tyvars that go into the reified
GADT constructor type signature to give them distinct uniques from their
counterparts in the tycon.
-}

------------------------------
reifyClass :: Class -> TcM TH.Info
reifyClass :: Class -> TcM Info
reifyClass Class
cls
  = do  { [Type]
cxt <- [Type] -> TcM [Type]
reifyCxt [Type]
theta
        ; InstEnvs
inst_envs <- TcM InstEnvs
tcGetInstEnvs
        ; [Dec]
insts <- Class -> [ClsInst] -> TcM [Dec]
reifyClassInstances Class
cls (InstEnvs -> Class -> [ClsInst]
InstEnv.classInstances InstEnvs
inst_envs Class
cls)
        ; [Dec]
assocTys <- forall (m :: * -> *) a b. Monad m => (a -> m [b]) -> [a] -> m [b]
concatMapM ClassATItem -> TcM [Dec]
reifyAT [ClassATItem]
ats
        ; [Dec]
ops <- forall (m :: * -> *) a b. Monad m => (a -> m [b]) -> [a] -> m [b]
concatMapM forall {a}. (Id, Maybe (a, DefMethSpec Type)) -> TcM [Dec]
reify_op [ClassOpItem]
op_stuff
        ; [TyVarBndr ()]
tvs' <- [Id] -> TcM [TyVarBndr ()]
reifyTyVars (TyCon -> [Id]
tyConVisibleTyVars (Class -> TyCon
classTyCon Class
cls))
        ; let dec :: Dec
dec = [Type] -> Name -> [TyVarBndr ()] -> [FunDep] -> [Dec] -> Dec
TH.ClassD [Type]
cxt (forall n. NamedThing n => n -> Name
reifyName Class
cls) [TyVarBndr ()]
tvs' [FunDep]
fds' ([Dec]
assocTys forall a. [a] -> [a] -> [a]
++ [Dec]
ops)
        ; forall (m :: * -> *) a. Monad m => a -> m a
return (Dec -> [Dec] -> Info
TH.ClassI Dec
dec [Dec]
insts) }
  where
    ([Id]
_, [FunDep Id]
fds, [Type]
theta, [Id]
_, [ClassATItem]
ats, [ClassOpItem]
op_stuff) = Class
-> ([Id], [FunDep Id], [Type], [Id], [ClassATItem], [ClassOpItem])
classExtraBigSig Class
cls
    fds' :: [FunDep]
fds' = forall a b. (a -> b) -> [a] -> [b]
map FunDep Id -> FunDep
reifyFunDep [FunDep Id]
fds
    reify_op :: (Id, Maybe (a, DefMethSpec Type)) -> TcM [Dec]
reify_op (Id
op, Maybe (a, DefMethSpec Type)
def_meth)
      = do { let ([Id]
_, Type
_, Type
ty) = Type -> ([Id], Type, Type)
tcSplitMethodTy (Id -> Type
idType Id
op)
               -- Use tcSplitMethodTy to get rid of the extraneous class
               -- variables and predicates at the beginning of op's type
               -- (see #15551).
           ; Type
ty' <- Type -> TcM Type
reifyType Type
ty
           ; let nm' :: Name
nm' = forall n. NamedThing n => n -> Name
reifyName Id
op
           ; case Maybe (a, DefMethSpec Type)
def_meth of
                Just (a
_, GenericDM Type
gdm_ty) ->
                  do { Type
gdm_ty' <- Type -> TcM Type
reifyType Type
gdm_ty
                     ; forall (m :: * -> *) a. Monad m => a -> m a
return [Name -> Type -> Dec
TH.SigD Name
nm' Type
ty', Name -> Type -> Dec
TH.DefaultSigD Name
nm' Type
gdm_ty'] }
                Maybe (a, DefMethSpec Type)
_ -> forall (m :: * -> *) a. Monad m => a -> m a
return [Name -> Type -> Dec
TH.SigD Name
nm' Type
ty'] }

    reifyAT :: ClassATItem -> TcM [TH.Dec]
    reifyAT :: ClassATItem -> TcM [Dec]
reifyAT (ATI TyCon
tycon Maybe (Type, ATValidityInfo)
def) = do
      Info
tycon' <- TyCon -> TcM Info
reifyTyCon TyCon
tycon
      case Info
tycon' of
        TH.FamilyI Dec
dec [Dec]
_ -> do
          let (Name
tyName, [Name]
tyArgs) = Dec -> (Name, [Name])
tfNames Dec
dec
          (Dec
dec forall a. a -> [a] -> [a]
:) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall b a. b -> (a -> b) -> Maybe a -> b
maybe (forall (m :: * -> *) a. Monad m => a -> m a
return [])
                            (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (forall a. a -> [a] -> [a]
:[]) forall b c a. (b -> c) -> (a -> b) -> a -> c
. Name -> [Name] -> Type -> IOEnv (Env TcGblEnv TcLclEnv) Dec
reifyDefImpl Name
tyName [Name]
tyArgs forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a, b) -> a
fst)
                            Maybe (Type, ATValidityInfo)
def
        Info
_ -> forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"reifyAT" (String -> SDoc
text (forall a. Show a => a -> String
show Info
tycon'))

    reifyDefImpl :: TH.Name -> [TH.Name] -> Type -> TcM TH.Dec
    reifyDefImpl :: Name -> [Name] -> Type -> IOEnv (Env TcGblEnv TcLclEnv) Dec
reifyDefImpl Name
n [Name]
args Type
ty =
      TySynEqn -> Dec
TH.TySynInstD forall b c a. (b -> c) -> (a -> b) -> a -> c
. Maybe [TyVarBndr ()] -> Type -> Type -> TySynEqn
TH.TySynEqn forall a. Maybe a
Nothing (Type -> [Type] -> Type
mkThAppTs (Name -> Type
TH.ConT Name
n) (forall a b. (a -> b) -> [a] -> [b]
map Name -> Type
TH.VarT [Name]
args))
                                  forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Type -> TcM Type
reifyType Type
ty

    tfNames :: TH.Dec -> (TH.Name, [TH.Name])
    tfNames :: Dec -> (Name, [Name])
tfNames (TH.OpenTypeFamilyD (TH.TypeFamilyHead Name
n [TyVarBndr ()]
args FamilyResultSig
_ Maybe InjectivityAnn
_))
      = (Name
n, forall a b. (a -> b) -> [a] -> [b]
map forall flag. TyVarBndr flag -> Name
bndrName [TyVarBndr ()]
args)
    tfNames Dec
d = forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"tfNames" (String -> SDoc
text (forall a. Show a => a -> String
show Dec
d))

    bndrName :: TH.TyVarBndr flag -> TH.Name
    bndrName :: forall flag. TyVarBndr flag -> Name
bndrName (TH.PlainTV Name
n flag
_)    = Name
n
    bndrName (TH.KindedTV Name
n flag
_ Type
_) = Name
n

------------------------------
-- | Annotate (with TH.SigT) a type if the first parameter is True
-- and if the type contains a free variable.
-- This is used to annotate type patterns for poly-kinded tyvars in
-- reifying class and type instances.
-- See @Note [Reified instances and explicit kind signatures]@.
annotThType :: Bool   -- True <=> annotate
            -> TyCoRep.Type -> TH.Type -> TcM TH.Type
  -- tiny optimization: if the type is annotated, don't annotate again.
annotThType :: Bool -> Type -> Type -> TcM Type
annotThType Bool
_    Type
_  th_ty :: Type
th_ty@(TH.SigT {}) = forall (m :: * -> *) a. Monad m => a -> m a
return Type
th_ty
annotThType Bool
True Type
ty Type
th_ty
  | Bool -> Bool
not forall a b. (a -> b) -> a -> b
$ VarSet -> Bool
isEmptyVarSet forall a b. (a -> b) -> a -> b
$ (Id -> Bool) -> VarSet -> VarSet
filterVarSet Id -> Bool
isTyVar forall a b. (a -> b) -> a -> b
$ Type -> VarSet
tyCoVarsOfType Type
ty
  = do { let ki :: Type
ki = HasDebugCallStack => Type -> Type
tcTypeKind Type
ty
       ; Type
th_ki <- Type -> TcM Type
reifyKind Type
ki
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (Type -> Type -> Type
TH.SigT Type
th_ty Type
th_ki) }
annotThType Bool
_    Type
_ Type
th_ty = forall (m :: * -> *) a. Monad m => a -> m a
return Type
th_ty

-- | For every argument type that a type constructor accepts,
-- report whether or not the argument is poly-kinded. This is used to
-- eventually feed into 'annotThType'.
-- See @Note [Reified instances and explicit kind signatures]@.
tyConArgsPolyKinded :: TyCon -> [Bool]
tyConArgsPolyKinded :: TyCon -> [Bool]
tyConArgsPolyKinded TyCon
tc =
     forall a b. (a -> b) -> [a] -> [b]
map (Type -> Bool
is_poly_ty forall b c a. (b -> c) -> (a -> b) -> a -> c
. Id -> Type
tyVarKind)      [Id]
tc_vis_tvs
     -- See "Wrinkle: Oversaturated data family instances" in
     -- @Note [Reified instances and explicit kind signatures]@
  forall a. [a] -> [a] -> [a]
++ forall a b. (a -> b) -> [a] -> [b]
map (Type -> Bool
is_poly_ty forall b c a. (b -> c) -> (a -> b) -> a -> c
. TyCoBinder -> Type
tyCoBinderType) [TyCoBinder]
tc_res_kind_vis_bndrs -- (1) in Wrinkle
  forall a. [a] -> [a] -> [a]
++ forall a. a -> [a]
repeat Bool
True                                             -- (2) in Wrinkle
  where
    is_poly_ty :: Type -> Bool
    is_poly_ty :: Type -> Bool
is_poly_ty Type
ty = Bool -> Bool
not forall a b. (a -> b) -> a -> b
$
                    VarSet -> Bool
isEmptyVarSet forall a b. (a -> b) -> a -> b
$
                    (Id -> Bool) -> VarSet -> VarSet
filterVarSet Id -> Bool
isTyVar forall a b. (a -> b) -> a -> b
$
                    Type -> VarSet
tyCoVarsOfType Type
ty

    tc_vis_tvs :: [TyVar]
    tc_vis_tvs :: [Id]
tc_vis_tvs = TyCon -> [Id]
tyConVisibleTyVars TyCon
tc

    tc_res_kind_vis_bndrs :: [TyCoBinder]
    tc_res_kind_vis_bndrs :: [TyCoBinder]
tc_res_kind_vis_bndrs = forall a. (a -> Bool) -> [a] -> [a]
filter TyCoBinder -> Bool
isVisibleBinder forall a b. (a -> b) -> a -> b
$ forall a b. (a, b) -> a
fst forall a b. (a -> b) -> a -> b
$ Type -> ([TyCoBinder], Type)
splitPiTys forall a b. (a -> b) -> a -> b
$ TyCon -> Type
tyConResKind TyCon
tc

{-
Note [Reified instances and explicit kind signatures]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Reified class instances and type family instances often include extra kind
information to disambiguate instances. Here is one such example that
illustrates this (#8953):

    type family Poly (a :: k) :: Type
    type instance Poly (x :: Bool)    = Int
    type instance Poly (x :: Maybe k) = Double

If you're not careful, reifying these instances might yield this:

    type instance Poly x = Int
    type instance Poly x = Double

To avoid this, we go through some care to annotate things with extra kind
information. Some functions which accomplish this feat include:

* annotThType: This annotates a type with a kind signature if the type contains
  a free variable.
* tyConArgsPolyKinded: This checks every argument that a type constructor can
  accept and reports if the type of the argument is poly-kinded. This
  information is ultimately fed into annotThType.

-----
-- Wrinkle: Oversaturated data family instances
-----

What constitutes an argument to a type constructor in the definition of
tyConArgsPolyKinded? For most type constructors, it's simply the visible
type variable binders (i.e., tyConVisibleTyVars). There is one corner case
we must keep in mind, however: data family instances can appear oversaturated
(#17296). For instance:

    data family   Foo :: Type -> Type
    data instance Foo x

    data family Bar :: k
    data family Bar x

For these sorts of data family instances, tyConVisibleTyVars isn't enough,
as they won't give you the kinds of the oversaturated arguments. We must
also consult:

1. The kinds of the arguments in the result kind (i.e., the tyConResKind).
   This will tell us, e.g., the kind of `x` in `Foo x` above.
2. If we go beyond the number of arguments in the result kind (like the
   `x` in `Bar x`), then we conservatively assume that the argument's
   kind is poly-kinded.

-----
-- Wrinkle: data family instances with return kinds
-----

Another squirrelly corner case is this:

    data family Foo (a :: k)
    data instance Foo :: Bool -> Type
    data instance Foo :: Char -> Type

If you're not careful, reifying these instances might yield this:

    data instance Foo
    data instance Foo

We can fix this ambiguity by reifying the instances' explicit return kinds. We
should only do this if necessary (see
Note [When does a tycon application need an explicit kind signature?] in GHC.Core.Type),
but more importantly, we *only* do this if either of the following are true:

1. The data family instance has no constructors.
2. The data family instance is declared with GADT syntax.

If neither of these are true, then reifying the return kind would yield
something like this:

    data instance (Bar a :: Type) = MkBar a

Which is not valid syntax.
-}

------------------------------
reifyClassInstances :: Class -> [ClsInst] -> TcM [TH.Dec]
reifyClassInstances :: Class -> [ClsInst] -> TcM [Dec]
reifyClassInstances Class
cls [ClsInst]
insts
  = forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM ([Bool] -> ClsInst -> IOEnv (Env TcGblEnv TcLclEnv) Dec
reifyClassInstance (TyCon -> [Bool]
tyConArgsPolyKinded (Class -> TyCon
classTyCon Class
cls))) [ClsInst]
insts

reifyClassInstance :: [Bool]  -- True <=> the corresponding tv is poly-kinded
                              -- includes only *visible* tvs
                   -> ClsInst -> TcM TH.Dec
reifyClassInstance :: [Bool] -> ClsInst -> IOEnv (Env TcGblEnv TcLclEnv) Dec
reifyClassInstance [Bool]
is_poly_tvs ClsInst
i
  = do { [Type]
cxt <- [Type] -> TcM [Type]
reifyCxt [Type]
theta
       ; let vis_types :: [Type]
vis_types = TyCon -> [Type] -> [Type]
filterOutInvisibleTypes TyCon
cls_tc [Type]
types
       ; [Type]
thtypes <- [Type] -> TcM [Type]
reifyTypes [Type]
vis_types
       ; [Type]
annot_thtypes <- forall (m :: * -> *) a b c d.
Monad m =>
(a -> b -> c -> m d) -> [a] -> [b] -> [c] -> m [d]
zipWith3M Bool -> Type -> Type -> TcM Type
annotThType [Bool]
is_poly_tvs [Type]
vis_types [Type]
thtypes
       ; let head_ty :: Type
head_ty = Type -> [Type] -> Type
mkThAppTs (Name -> Type
TH.ConT (forall n. NamedThing n => n -> Name
reifyName Class
cls)) [Type]
annot_thtypes
       ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ (Maybe Overlap -> [Type] -> Type -> [Dec] -> Dec
TH.InstanceD Maybe Overlap
over [Type]
cxt Type
head_ty []) }
  where
     ([Id]
_tvs, [Type]
theta, Class
cls, [Type]
types) = Type -> ([Id], [Type], Class, [Type])
tcSplitDFunTy (Id -> Type
idType Id
dfun)
     cls_tc :: TyCon
cls_tc   = Class -> TyCon
classTyCon Class
cls
     dfun :: Id
dfun     = ClsInst -> Id
instanceDFunId ClsInst
i
     over :: Maybe Overlap
over     = case OverlapFlag -> OverlapMode
overlapMode (ClsInst -> OverlapFlag
is_flag ClsInst
i) of
                  NoOverlap SourceText
_     -> forall a. Maybe a
Nothing
                  Overlappable SourceText
_  -> forall a. a -> Maybe a
Just Overlap
TH.Overlappable
                  Overlapping SourceText
_   -> forall a. a -> Maybe a
Just Overlap
TH.Overlapping
                  Overlaps SourceText
_      -> forall a. a -> Maybe a
Just Overlap
TH.Overlaps
                  Incoherent SourceText
_    -> forall a. a -> Maybe a
Just Overlap
TH.Incoherent

------------------------------
reifyFamilyInstances :: TyCon -> [FamInst] -> TcM [TH.Dec]
reifyFamilyInstances :: TyCon -> [FamInst] -> TcM [Dec]
reifyFamilyInstances TyCon
fam_tc [FamInst]
fam_insts
  = forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM ([Bool] -> FamInst -> IOEnv (Env TcGblEnv TcLclEnv) Dec
reifyFamilyInstance (TyCon -> [Bool]
tyConArgsPolyKinded TyCon
fam_tc)) [FamInst]
fam_insts

reifyFamilyInstance :: [Bool] -- True <=> the corresponding tv is poly-kinded
                              -- includes only *visible* tvs
                    -> FamInst -> TcM TH.Dec
reifyFamilyInstance :: [Bool] -> FamInst -> IOEnv (Env TcGblEnv TcLclEnv) Dec
reifyFamilyInstance [Bool]
is_poly_tvs (FamInst { fi_flavor :: FamInst -> FamFlavor
fi_flavor = FamFlavor
flavor
                                         , fi_axiom :: FamInst -> CoAxiom Unbranched
fi_axiom = CoAxiom Unbranched
ax
                                         , fi_fam :: FamInst -> Name
fi_fam = Name
fam })
  | let fam_tc :: TyCon
fam_tc = forall (br :: BranchFlag). CoAxiom br -> TyCon
coAxiomTyCon CoAxiom Unbranched
ax
        branch :: CoAxBranch
branch = CoAxiom Unbranched -> CoAxBranch
coAxiomSingleBranch CoAxiom Unbranched
ax
  , CoAxBranch { cab_tvs :: CoAxBranch -> [Id]
cab_tvs = [Id]
tvs, cab_lhs :: CoAxBranch -> [Type]
cab_lhs = [Type]
lhs, cab_rhs :: CoAxBranch -> Type
cab_rhs = Type
rhs } <- CoAxBranch
branch
  = case FamFlavor
flavor of
      FamFlavor
SynFamilyInst ->
               -- remove kind patterns (#8884)
        do { Maybe [TyVarBndr ()]
th_tvs <- [Id] -> TcM (Maybe [TyVarBndr ()])
reifyTyVarsToMaybe [Id]
tvs
           ; let lhs_types_only :: [Type]
lhs_types_only = TyCon -> [Type] -> [Type]
filterOutInvisibleTypes TyCon
fam_tc [Type]
lhs
           ; [Type]
th_lhs <- [Type] -> TcM [Type]
reifyTypes [Type]
lhs_types_only
           ; [Type]
annot_th_lhs <- forall (m :: * -> *) a b c d.
Monad m =>
(a -> b -> c -> m d) -> [a] -> [b] -> [c] -> m [d]
zipWith3M Bool -> Type -> Type -> TcM Type
annotThType [Bool]
is_poly_tvs [Type]
lhs_types_only
                                                   [Type]
th_lhs
           ; let lhs_type :: Type
lhs_type = Type -> [Type] -> Type
mkThAppTs (Name -> Type
TH.ConT forall a b. (a -> b) -> a -> b
$ forall n. NamedThing n => n -> Name
reifyName Name
fam) [Type]
annot_th_lhs
           ; Type
th_rhs <- Type -> TcM Type
reifyType Type
rhs
           ; forall (m :: * -> *) a. Monad m => a -> m a
return (TySynEqn -> Dec
TH.TySynInstD (Maybe [TyVarBndr ()] -> Type -> Type -> TySynEqn
TH.TySynEqn Maybe [TyVarBndr ()]
th_tvs Type
lhs_type Type
th_rhs)) }

      DataFamilyInst TyCon
rep_tc ->
        do { let -- eta-expand lhs types, because sometimes data/newtype
                 -- instances are eta-reduced; See #9692
                 -- See Note [Eta reduction for data families] in GHC.Core.Coercion.Axiom
                 ([Id]
ee_tvs, [Type]
ee_lhs, Type
_) = CoAxBranch -> ([Id], [Type], Type)
etaExpandCoAxBranch CoAxBranch
branch
                 fam' :: Name
fam'     = forall n. NamedThing n => n -> Name
reifyName Name
fam
                 dataCons :: [DataCon]
dataCons = TyCon -> [DataCon]
tyConDataCons TyCon
rep_tc
                 isGadt :: Bool
isGadt   = TyCon -> Bool
isGadtSyntaxTyCon TyCon
rep_tc
           ; Maybe [TyVarBndr ()]
th_tvs <- [Id] -> TcM (Maybe [TyVarBndr ()])
reifyTyVarsToMaybe [Id]
ee_tvs
           ; [Con]
cons <- forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (Bool -> [Type] -> DataCon -> TcM Con
reifyDataCon Bool
isGadt ([Id] -> [Type]
mkTyVarTys [Id]
ee_tvs)) [DataCon]
dataCons
           ; let types_only :: [Type]
types_only = TyCon -> [Type] -> [Type]
filterOutInvisibleTypes TyCon
fam_tc [Type]
ee_lhs
           ; [Type]
th_tys <- [Type] -> TcM [Type]
reifyTypes [Type]
types_only
           ; [Type]
annot_th_tys <- forall (m :: * -> *) a b c d.
Monad m =>
(a -> b -> c -> m d) -> [a] -> [b] -> [c] -> m [d]
zipWith3M Bool -> Type -> Type -> TcM Type
annotThType [Bool]
is_poly_tvs [Type]
types_only [Type]
th_tys
           ; let lhs_type :: Type
lhs_type = Type -> [Type] -> Type
mkThAppTs (Name -> Type
TH.ConT Name
fam') [Type]
annot_th_tys
           ; Maybe Type
mb_sig <-
               -- See "Wrinkle: data family instances with return kinds" in
               -- Note [Reified instances and explicit kind signatures]
               if (forall (t :: * -> *) a. Foldable t => t a -> Bool
null [Con]
cons Bool -> Bool -> Bool
|| TyCon -> Bool
isGadtSyntaxTyCon TyCon
rep_tc)
                     Bool -> Bool -> Bool
&& Bool -> TyCon -> SumArity -> Bool
tyConAppNeedsKindSig Bool
False TyCon
fam_tc (forall (t :: * -> *) a. Foldable t => t a -> SumArity
length [Type]
ee_lhs)
               then do { let full_kind :: Type
full_kind = HasDebugCallStack => Type -> Type
tcTypeKind (TyCon -> [Type] -> Type
mkTyConApp TyCon
fam_tc [Type]
ee_lhs)
                       ; Type
th_full_kind <- Type -> TcM Type
reifyKind Type
full_kind
                       ; forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ forall a. a -> Maybe a
Just Type
th_full_kind }
               else forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a. Maybe a
Nothing
           ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$
               if TyCon -> Bool
isNewTyCon TyCon
rep_tc
               then [Type]
-> Maybe [TyVarBndr ()]
-> Type
-> Maybe Type
-> Con
-> [DerivClause]
-> Dec
TH.NewtypeInstD [] Maybe [TyVarBndr ()]
th_tvs Type
lhs_type Maybe Type
mb_sig (forall a. [a] -> a
head [Con]
cons) []
               else [Type]
-> Maybe [TyVarBndr ()]
-> Type
-> Maybe Type
-> [Con]
-> [DerivClause]
-> Dec
TH.DataInstD    [] Maybe [TyVarBndr ()]
th_tvs Type
lhs_type Maybe Type
mb_sig       [Con]
cons  []
           }

------------------------------
reifyType :: TyCoRep.Type -> TcM TH.Type
-- Monadic only because of failure
reifyType :: Type -> TcM Type
reifyType Type
ty                | Type -> Bool
tcIsLiftedTypeKind Type
ty = forall (m :: * -> *) a. Monad m => a -> m a
return Type
TH.StarT
  -- Make sure to use tcIsLiftedTypeKind here, since we don't want to confuse it
  -- with Constraint (#14869).
reifyType ty :: Type
ty@(ForAllTy (Bndr Id
_ ArgFlag
argf) Type
_)
                            = ArgFlag -> Type -> TcM Type
reify_for_all ArgFlag
argf Type
ty
reifyType (LitTy TyLit
t)         = do { TyLit
r <- TyLit -> TcM TyLit
reifyTyLit TyLit
t; forall (m :: * -> *) a. Monad m => a -> m a
return (TyLit -> Type
TH.LitT TyLit
r) }
reifyType (TyVarTy Id
tv)      = forall (m :: * -> *) a. Monad m => a -> m a
return (Name -> Type
TH.VarT (forall n. NamedThing n => n -> Name
reifyName Id
tv))
reifyType (TyConApp TyCon
tc [Type]
tys) = TyCon -> [Type] -> TcM Type
reify_tc_app TyCon
tc [Type]
tys   -- Do not expand type synonyms here
reifyType ty :: Type
ty@(AppTy {})     = do
  let (Type
ty_head, [Type]
ty_args) = Type -> (Type, [Type])
splitAppTys Type
ty
  Type
ty_head' <- Type -> TcM Type
reifyType Type
ty_head
  [Type]
ty_args' <- [Type] -> TcM [Type]
reifyTypes (Type -> [Type] -> [Type]
filter_out_invisible_args Type
ty_head [Type]
ty_args)
  forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ Type -> [Type] -> Type
mkThAppTs Type
ty_head' [Type]
ty_args'
  where
    -- Make sure to filter out any invisible arguments. For instance, if you
    -- reify the following:
    --
    --   newtype T (f :: forall a. a -> Type) = MkT (f Bool)
    --
    -- Then you should receive back `f Bool`, not `f Type Bool`, since the
    -- `Type` argument is invisible (#15792).
    filter_out_invisible_args :: Type -> [Type] -> [Type]
    filter_out_invisible_args :: Type -> [Type] -> [Type]
filter_out_invisible_args Type
ty_head [Type]
ty_args =
      forall a. [Bool] -> [a] -> [a]
filterByList (forall a b. (a -> b) -> [a] -> [b]
map ArgFlag -> Bool
isVisibleArgFlag forall a b. (a -> b) -> a -> b
$ Type -> [Type] -> [ArgFlag]
appTyArgFlags Type
ty_head [Type]
ty_args)
                   [Type]
ty_args
reifyType ty :: Type
ty@(FunTy { ft_af :: Type -> AnonArgFlag
ft_af = AnonArgFlag
af, ft_mult :: Type -> Type
ft_mult = Type
Many, ft_arg :: Type -> Type
ft_arg = Type
t1, ft_res :: Type -> Type
ft_res = Type
t2 })
  | AnonArgFlag
InvisArg <- AnonArgFlag
af = ArgFlag -> Type -> TcM Type
reify_for_all ArgFlag
Inferred Type
ty  -- Types like ((?x::Int) => Char -> Char)
  | Bool
otherwise      = do { [Type
r1,Type
r2] <- [Type] -> TcM [Type]
reifyTypes [Type
t1,Type
t2]
                        ; forall (m :: * -> *) a. Monad m => a -> m a
return (Type
TH.ArrowT Type -> Type -> Type
`TH.AppT` Type
r1 Type -> Type -> Type
`TH.AppT` Type
r2) }
reifyType ty :: Type
ty@(FunTy { ft_af :: Type -> AnonArgFlag
ft_af = AnonArgFlag
af, ft_mult :: Type -> Type
ft_mult = Type
tm, ft_arg :: Type -> Type
ft_arg = Type
t1, ft_res :: Type -> Type
ft_res = Type
t2 })
  | AnonArgFlag
InvisArg <- AnonArgFlag
af = forall a. PtrString -> SDoc -> TcM a
noTH (String -> PtrString
sLit String
"linear invisible argument") (forall a. Outputable a => a -> SDoc
ppr Type
ty)
  | Bool
otherwise      = do { [Type
rm,Type
r1,Type
r2] <- [Type] -> TcM [Type]
reifyTypes [Type
tm,Type
t1,Type
t2]
                        ; forall (m :: * -> *) a. Monad m => a -> m a
return (Type
TH.MulArrowT Type -> Type -> Type
`TH.AppT` Type
rm Type -> Type -> Type
`TH.AppT` Type
r1 Type -> Type -> Type
`TH.AppT` Type
r2) }
reifyType (CastTy Type
t KindCoercion
_)      = Type -> TcM Type
reifyType Type
t -- Casts are ignored in TH
reifyType ty :: Type
ty@(CoercionTy {})= forall a. PtrString -> SDoc -> TcM a
noTH (String -> PtrString
sLit String
"coercions in types") (forall a. Outputable a => a -> SDoc
ppr Type
ty)

reify_for_all :: TyCoRep.ArgFlag -> TyCoRep.Type -> TcM TH.Type
-- Arg of reify_for_all is always ForAllTy or a predicate FunTy
reify_for_all :: ArgFlag -> Type -> TcM Type
reify_for_all ArgFlag
argf Type
ty
  | ArgFlag -> Bool
isVisibleArgFlag ArgFlag
argf
  = do let ([TcReqTVBinder]
req_bndrs, Type
phi) = Type -> ([TcReqTVBinder], Type)
tcSplitForAllReqTVBinders Type
ty
       [TyVarBndr ()]
tvbndrs' <- forall flag flag'.
ReifyFlag flag flag' =>
[VarBndr Id flag] -> TcM [TyVarBndr flag']
reifyTyVarBndrs [TcReqTVBinder]
req_bndrs
       Type
phi' <- Type -> TcM Type
reifyType Type
phi
       forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ [TyVarBndr ()] -> Type -> Type
TH.ForallVisT [TyVarBndr ()]
tvbndrs' Type
phi'
  | Bool
otherwise
  = do let ([InvisTVBinder]
inv_bndrs, Type
phi) = Type -> ([InvisTVBinder], Type)
tcSplitForAllInvisTVBinders Type
ty
       [TyVarBndr Specificity]
tvbndrs' <- forall flag flag'.
ReifyFlag flag flag' =>
[VarBndr Id flag] -> TcM [TyVarBndr flag']
reifyTyVarBndrs [InvisTVBinder]
inv_bndrs
       let ([Type]
cxt, Type
tau) = Type -> ([Type], Type)
tcSplitPhiTy Type
phi
       [Type]
cxt' <- [Type] -> TcM [Type]
reifyCxt [Type]
cxt
       Type
tau' <- Type -> TcM Type
reifyType Type
tau
       forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ [TyVarBndr Specificity] -> [Type] -> Type -> Type
TH.ForallT [TyVarBndr Specificity]
tvbndrs' [Type]
cxt' Type
tau'

reifyTyLit :: TyCoRep.TyLit -> TcM TH.TyLit
reifyTyLit :: TyLit -> TcM TyLit
reifyTyLit (NumTyLit Integer
n) = forall (m :: * -> *) a. Monad m => a -> m a
return (Integer -> TyLit
TH.NumTyLit Integer
n)
reifyTyLit (StrTyLit FastString
s) = forall (m :: * -> *) a. Monad m => a -> m a
return (String -> TyLit
TH.StrTyLit (FastString -> String
unpackFS FastString
s))
reifyTyLit (CharTyLit Char
c) = forall (m :: * -> *) a. Monad m => a -> m a
return (Char -> TyLit
TH.CharTyLit Char
c)

reifyTypes :: [Type] -> TcM [TH.Type]
reifyTypes :: [Type] -> TcM [Type]
reifyTypes = forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM Type -> TcM Type
reifyType

reifyPatSynType
  :: ([InvisTVBinder], ThetaType, [InvisTVBinder], ThetaType, [Scaled Type], Type) -> TcM TH.Type
-- reifies a pattern synonym's type and returns its *complete* type
-- signature; see NOTE [Pattern synonym signatures and Template
-- Haskell]
reifyPatSynType :: ([InvisTVBinder], [Type], [InvisTVBinder], [Type], [Scaled Type],
 Type)
-> TcM Type
reifyPatSynType ([InvisTVBinder]
univTyVars, [Type]
req, [InvisTVBinder]
exTyVars, [Type]
prov, [Scaled Type]
argTys, Type
resTy)
  = do { [TyVarBndr Specificity]
univTyVars' <- forall flag flag'.
ReifyFlag flag flag' =>
[VarBndr Id flag] -> TcM [TyVarBndr flag']
reifyTyVarBndrs [InvisTVBinder]
univTyVars
       ; [Type]
req'        <- [Type] -> TcM [Type]
reifyCxt [Type]
req
       ; [TyVarBndr Specificity]
exTyVars'   <- forall flag flag'.
ReifyFlag flag flag' =>
[VarBndr Id flag] -> TcM [TyVarBndr flag']
reifyTyVarBndrs [InvisTVBinder]
exTyVars
       ; [Type]
prov'       <- [Type] -> TcM [Type]
reifyCxt [Type]
prov
       ; Type
tau'        <- Type -> TcM Type
reifyType ([Scaled Type] -> Type -> Type
mkVisFunTys [Scaled Type]
argTys Type
resTy)
       ; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ [TyVarBndr Specificity] -> [Type] -> Type -> Type
TH.ForallT [TyVarBndr Specificity]
univTyVars' [Type]
req'
                forall a b. (a -> b) -> a -> b
$ [TyVarBndr Specificity] -> [Type] -> Type -> Type
TH.ForallT [TyVarBndr Specificity]
exTyVars' [Type]
prov' Type
tau' }

reifyKind :: Kind -> TcM TH.Kind
reifyKind :: Type -> TcM Type
reifyKind = Type -> TcM Type
reifyType

reifyCxt :: [PredType] -> TcM [TH.Pred]
reifyCxt :: [Type] -> TcM [Type]
reifyCxt   = forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM Type -> TcM Type
reifyType

reifyFunDep :: ([TyVar], [TyVar]) -> TH.FunDep
reifyFunDep :: FunDep Id -> FunDep
reifyFunDep ([Id]
xs, [Id]
ys) = [Name] -> [Name] -> FunDep
TH.FunDep (forall a b. (a -> b) -> [a] -> [b]
map forall n. NamedThing n => n -> Name
reifyName [Id]
xs) (forall a b. (a -> b) -> [a] -> [b]
map forall n. NamedThing n => n -> Name
reifyName [Id]
ys)

class ReifyFlag flag flag' | flag -> flag' where
    reifyFlag :: flag -> flag'

instance ReifyFlag () () where
    reifyFlag :: () -> ()
reifyFlag () = ()

instance ReifyFlag Specificity TH.Specificity where
    reifyFlag :: Specificity -> Specificity
reifyFlag Specificity
SpecifiedSpec = Specificity
TH.SpecifiedSpec
    reifyFlag Specificity
InferredSpec  = Specificity
TH.InferredSpec

reifyTyVars :: [TyVar] -> TcM [TH.TyVarBndr ()]
reifyTyVars :: [Id] -> TcM [TyVarBndr ()]
reifyTyVars = forall flag flag'.
ReifyFlag flag flag' =>
[VarBndr Id flag] -> TcM [TyVarBndr flag']
reifyTyVarBndrs forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map forall {var}. var -> VarBndr var ()
mk_bndr
  where
    mk_bndr :: var -> VarBndr var ()
mk_bndr var
tv = forall var argf. var -> argf -> VarBndr var argf
Bndr var
tv ()

reifyTyVarBndrs :: ReifyFlag flag flag'
                => [VarBndr TyVar flag] -> TcM [TH.TyVarBndr flag']
reifyTyVarBndrs :: forall flag flag'.
ReifyFlag flag flag' =>
[VarBndr Id flag] -> TcM [TyVarBndr flag']
reifyTyVarBndrs = forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM forall {flag} {flag}.
ReifyFlag flag flag =>
VarBndr Id flag -> IOEnv (Env TcGblEnv TcLclEnv) (TyVarBndr flag)
reify_tvbndr
  where
    -- even if the kind is *, we need to include a kind annotation,
    -- in case a poly-kind would be inferred without the annotation.
    -- See #8953 or test th/T8953
    reify_tvbndr :: VarBndr Id flag -> IOEnv (Env TcGblEnv TcLclEnv) (TyVarBndr flag)
reify_tvbndr (Bndr Id
tv flag
fl) = forall flag. Name -> flag -> Type -> TyVarBndr flag
TH.KindedTV (forall n. NamedThing n => n -> Name
reifyName Id
tv)
                                            (forall flag flag'. ReifyFlag flag flag' => flag -> flag'
reifyFlag flag
fl)
                                            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Type -> TcM Type
reifyKind (Id -> Type
tyVarKind Id
tv)

reifyTyVarsToMaybe :: [TyVar] -> TcM (Maybe [TH.TyVarBndr ()])
reifyTyVarsToMaybe :: [Id] -> TcM (Maybe [TyVarBndr ()])
reifyTyVarsToMaybe []  = forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a. Maybe a
Nothing
reifyTyVarsToMaybe [Id]
tys = forall a. a -> Maybe a
Just forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> [Id] -> TcM [TyVarBndr ()]
reifyTyVars [Id]
tys

reify_tc_app :: TyCon -> [Type.Type] -> TcM TH.Type
reify_tc_app :: TyCon -> [Type] -> TcM Type
reify_tc_app TyCon
tc [Type]
tys
  = do { [Type]
tys' <- [Type] -> TcM [Type]
reifyTypes (TyCon -> [Type] -> [Type]
filterOutInvisibleTypes TyCon
tc [Type]
tys)
       ; Type -> TcM Type
maybe_sig_t (Type -> [Type] -> Type
mkThAppTs Type
r_tc [Type]
tys') }
  where
    arity :: SumArity
arity       = TyCon -> SumArity
tyConArity TyCon
tc

    r_tc :: Type
r_tc | TyCon -> Bool
isUnboxedSumTyCon TyCon
tc           = SumArity -> Type
TH.UnboxedSumT (SumArity
arity forall a. Integral a => a -> a -> a
`div` SumArity
2)
         | TyCon -> Bool
isUnboxedTupleTyCon TyCon
tc         = SumArity -> Type
TH.UnboxedTupleT (SumArity
arity forall a. Integral a => a -> a -> a
`div` SumArity
2)
         | TyCon -> Bool
isPromotedTupleTyCon TyCon
tc        = SumArity -> Type
TH.PromotedTupleT (SumArity
arity forall a. Integral a => a -> a -> a
`div` SumArity
2)
             -- See Note [Unboxed tuple RuntimeRep vars] in GHC.Core.TyCon
         | TyCon -> Bool
isTupleTyCon TyCon
tc                = if TyCon -> Bool
isPromotedDataCon TyCon
tc
                                            then SumArity -> Type
TH.PromotedTupleT SumArity
arity
                                            else SumArity -> Type
TH.TupleT SumArity
arity
         | TyCon
tc forall a. Uniquable a => a -> Unique -> Bool
`hasKey` Unique
constraintKindTyConKey
                                          = Type
TH.ConstraintT
         | TyCon
tc forall a. Uniquable a => a -> Unique -> Bool
`hasKey` Unique
unrestrictedFunTyConKey = Type
TH.ArrowT
         | TyCon
tc forall a. Uniquable a => a -> Unique -> Bool
`hasKey` Unique
listTyConKey       = Type
TH.ListT
         | TyCon
tc forall a. Uniquable a => a -> Unique -> Bool
`hasKey` Unique
nilDataConKey      = Type
TH.PromotedNilT
         | TyCon
tc forall a. Uniquable a => a -> Unique -> Bool
`hasKey` Unique
consDataConKey     = Type
TH.PromotedConsT
         | TyCon
tc forall a. Uniquable a => a -> Unique -> Bool
`hasKey` Unique
heqTyConKey        = Type
TH.EqualityT
         | TyCon
tc forall a. Uniquable a => a -> Unique -> Bool
`hasKey` Unique
eqPrimTyConKey     = Type
TH.EqualityT
         | TyCon
tc forall a. Uniquable a => a -> Unique -> Bool
`hasKey` Unique
eqReprPrimTyConKey = Name -> Type
TH.ConT (forall n. NamedThing n => n -> Name
reifyName TyCon
coercibleTyCon)
         | TyCon -> Bool
isPromotedDataCon TyCon
tc           = Name -> Type
TH.PromotedT (forall n. NamedThing n => n -> Name
reifyName TyCon
tc)
         | Bool
otherwise                      = Name -> Type
TH.ConT (forall n. NamedThing n => n -> Name
reifyName TyCon
tc)

    -- See Note [When does a tycon application need an explicit kind
    -- signature?] in GHC.Core.TyCo.Rep
    maybe_sig_t :: Type -> TcM Type
maybe_sig_t Type
th_type
      | Bool -> TyCon -> SumArity -> Bool
tyConAppNeedsKindSig
          Bool
False -- We don't reify types using visible kind applications, so
                -- don't count specified binders as contributing towards
                -- injective positions in the kind of the tycon.
          TyCon
tc (forall (t :: * -> *) a. Foldable t => t a -> SumArity
length [Type]
tys)
      = do { let full_kind :: Type
full_kind = HasDebugCallStack => Type -> Type
tcTypeKind (TyCon -> [Type] -> Type
mkTyConApp TyCon
tc [Type]
tys)
           ; Type
th_full_kind <- Type -> TcM Type
reifyKind Type
full_kind
           ; forall (m :: * -> *) a. Monad m => a -> m a
return (Type -> Type -> Type
TH.SigT Type
th_type Type
th_full_kind) }
      | Bool
otherwise
      = forall (m :: * -> *) a. Monad m => a -> m a
return Type
th_type

------------------------------
reifyName :: NamedThing n => n -> TH.Name
reifyName :: forall n. NamedThing n => n -> Name
reifyName n
thing
  | Name -> Bool
isExternalName Name
name
              = String -> String -> String -> Name
mk_varg String
pkg_str String
mod_str String
occ_str
  | Bool
otherwise = String -> Integer -> Name
TH.mkNameU String
occ_str (forall a. Integral a => a -> Integer
toInteger forall a b. (a -> b) -> a -> b
$ Unique -> SumArity
getKey (forall a. Uniquable a => a -> Unique
getUnique Name
name))
        -- Many of the things we reify have local bindings, and
        -- NameL's aren't supposed to appear in binding positions, so
        -- we use NameU.  When/if we start to reify nested things, that
        -- have free variables, we may need to generate NameL's for them.
  where
    name :: Name
name    = forall a. NamedThing a => a -> Name
getName n
thing
    mod :: GenModule Unit
mod     = ASSERT( isExternalName name ) nameModule name
    pkg_str :: String
pkg_str = forall u. IsUnitId u => u -> String
unitString (forall unit. GenModule unit -> unit
moduleUnit GenModule Unit
mod)
    mod_str :: String
mod_str = ModuleName -> String
moduleNameString (forall unit. GenModule unit -> ModuleName
moduleName GenModule Unit
mod)
    occ_str :: String
occ_str = OccName -> String
occNameString OccName
occ
    occ :: OccName
occ     = Name -> OccName
nameOccName Name
name
    mk_varg :: String -> String -> String -> Name
mk_varg | OccName -> Bool
OccName.isDataOcc OccName
occ = String -> String -> String -> Name
TH.mkNameG_d
            | OccName -> Bool
OccName.isVarOcc  OccName
occ = String -> String -> String -> Name
TH.mkNameG_v
            | OccName -> Bool
OccName.isTcOcc   OccName
occ = String -> String -> String -> Name
TH.mkNameG_tc
            | Bool
otherwise             = forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"reifyName" (forall a. Outputable a => a -> SDoc
ppr Name
name)

-- See Note [Reifying field labels]
reifyFieldLabel :: FieldLabel -> TH.Name
reifyFieldLabel :: FieldLabel -> Name
reifyFieldLabel FieldLabel
fl
  | FieldLabel -> Bool
flIsOverloaded FieldLabel
fl
              = OccName -> NameFlavour -> Name
TH.Name (String -> OccName
TH.mkOccName String
occ_str) (ModName -> NameFlavour
TH.NameQ (String -> ModName
TH.mkModName String
mod_str))
  | Bool
otherwise = String -> String -> String -> Name
TH.mkNameG_v String
pkg_str String
mod_str String
occ_str
  where
    name :: Name
name    = FieldLabel -> Name
flSelector FieldLabel
fl
    mod :: GenModule Unit
mod     = ASSERT( isExternalName name ) nameModule name
    pkg_str :: String
pkg_str = forall u. IsUnitId u => u -> String
unitString (forall unit. GenModule unit -> unit
moduleUnit GenModule Unit
mod)
    mod_str :: String
mod_str = ModuleName -> String
moduleNameString (forall unit. GenModule unit -> ModuleName
moduleName GenModule Unit
mod)
    occ_str :: String
occ_str = FastString -> String
unpackFS (FieldLabel -> FastString
flLabel FieldLabel
fl)

reifySelector :: Id -> TyCon -> TH.Name
reifySelector :: Id -> TyCon -> Name
reifySelector Id
id TyCon
tc
  = case forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Maybe a
find ((Id -> Name
idName Id
id forall a. Eq a => a -> a -> Bool
==) forall b c a. (b -> c) -> (a -> b) -> a -> c
. FieldLabel -> Name
flSelector) (TyCon -> [FieldLabel]
tyConFieldLabels TyCon
tc) of
      Just FieldLabel
fl -> FieldLabel -> Name
reifyFieldLabel FieldLabel
fl
      Maybe FieldLabel
Nothing -> forall a. HasCallStack => String -> SDoc -> a
pprPanic String
"reifySelector: missing field" (forall a. Outputable a => a -> SDoc
ppr Id
id SDoc -> SDoc -> SDoc
$$ forall a. Outputable a => a -> SDoc
ppr TyCon
tc)

------------------------------
reifyFixity :: Name -> TcM (Maybe TH.Fixity)
reifyFixity :: Name -> TcM (Maybe Fixity)
reifyFixity Name
name
  = do { (Bool
found, Fixity
fix) <- Name -> RnM (Bool, Fixity)
lookupFixityRn_help Name
name
       ; forall (m :: * -> *) a. Monad m => a -> m a
return (if Bool
found then forall a. a -> Maybe a
Just (Fixity -> Fixity
conv_fix Fixity
fix) else forall a. Maybe a
Nothing) }
    where
      conv_fix :: Fixity -> Fixity
conv_fix (Hs.Fixity SourceText
_ SumArity
i FixityDirection
d) = SumArity -> FixityDirection -> Fixity
TH.Fixity SumArity
i (FixityDirection -> FixityDirection
conv_dir FixityDirection
d)
      conv_dir :: FixityDirection -> FixityDirection
conv_dir FixityDirection
Hs.InfixR = FixityDirection
TH.InfixR
      conv_dir FixityDirection
Hs.InfixL = FixityDirection
TH.InfixL
      conv_dir FixityDirection
Hs.InfixN = FixityDirection
TH.InfixN

reifyUnpackedness :: DataCon.SrcUnpackedness -> TH.SourceUnpackedness
reifyUnpackedness :: SrcUnpackedness -> SourceUnpackedness
reifyUnpackedness SrcUnpackedness
NoSrcUnpack = SourceUnpackedness
TH.NoSourceUnpackedness
reifyUnpackedness SrcUnpackedness
SrcNoUnpack = SourceUnpackedness
TH.SourceNoUnpack
reifyUnpackedness SrcUnpackedness
SrcUnpack   = SourceUnpackedness
TH.SourceUnpack

reifyStrictness :: DataCon.SrcStrictness -> TH.SourceStrictness
reifyStrictness :: SrcStrictness -> SourceStrictness
reifyStrictness SrcStrictness
NoSrcStrict = SourceStrictness
TH.NoSourceStrictness
reifyStrictness SrcStrictness
SrcStrict   = SourceStrictness
TH.SourceStrict
reifyStrictness SrcStrictness
SrcLazy     = SourceStrictness
TH.SourceLazy

reifySourceBang :: DataCon.HsSrcBang
                -> (TH.SourceUnpackedness, TH.SourceStrictness)
reifySourceBang :: HsSrcBang -> (SourceUnpackedness, SourceStrictness)
reifySourceBang (HsSrcBang SourceText
_ SrcUnpackedness
u SrcStrictness
s) = (SrcUnpackedness -> SourceUnpackedness
reifyUnpackedness SrcUnpackedness
u, SrcStrictness -> SourceStrictness
reifyStrictness SrcStrictness
s)

reifyDecidedStrictness :: DataCon.HsImplBang -> TH.DecidedStrictness
reifyDecidedStrictness :: HsImplBang -> DecidedStrictness
reifyDecidedStrictness HsImplBang
HsLazy     = DecidedStrictness
TH.DecidedLazy
reifyDecidedStrictness HsImplBang
HsStrict   = DecidedStrictness
TH.DecidedStrict
reifyDecidedStrictness HsUnpack{} = DecidedStrictness
TH.DecidedUnpack

reifyTypeOfThing :: TH.Name -> TcM TH.Type
reifyTypeOfThing :: Name -> TcM Type
reifyTypeOfThing Name
th_name = do
  TcTyThing
thing <- Name -> TcM TcTyThing
getThing Name
th_name
  case TcTyThing
thing of
    AGlobal (AnId Id
id) -> Type -> TcM Type
reifyType (Id -> Type
idType Id
id)
    AGlobal (ATyCon TyCon
tc) -> Type -> TcM Type
reifyKind (TyCon -> Type
tyConKind TyCon
tc)
    AGlobal (AConLike (RealDataCon DataCon
dc)) ->
      Type -> TcM Type
reifyType (Id -> Type
idType (DataCon -> Id
dataConWrapId DataCon
dc))
    AGlobal (AConLike (PatSynCon PatSyn
ps)) ->
      ([InvisTVBinder], [Type], [InvisTVBinder], [Type], [Scaled Type],
 Type)
-> TcM Type
reifyPatSynType (PatSyn
-> ([InvisTVBinder], [Type], [InvisTVBinder], [Type],
    [Scaled Type], Type)
patSynSigBndr PatSyn
ps)
    ATcId{tct_id :: TcTyThing -> Id
tct_id = Id
id} -> Type -> IOEnv (Env TcGblEnv TcLclEnv) Type
zonkTcType (Id -> Type
idType Id
id) forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= Type -> TcM Type
reifyType
    ATyVar Name
_ Id
tctv -> Id -> IOEnv (Env TcGblEnv TcLclEnv) Type
zonkTcTyVar Id
tctv forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= Type -> TcM Type
reifyType
    -- Impossible cases, supposedly:
    AGlobal (ACoAxiom CoAxiom Branched
_) -> forall a. String -> a
panic String
"reifyTypeOfThing: ACoAxiom"
    ATcTyCon TyCon
_ -> forall a. String -> a
panic String
"reifyTypeOfThing: ATcTyCon"
    APromotionErr PromotionErr
_ -> forall a. String -> a
panic String
"reifyTypeOfThing: APromotionErr"

------------------------------
lookupThAnnLookup :: TH.AnnLookup -> TcM CoreAnnTarget
lookupThAnnLookup :: AnnLookup -> TcM CoreAnnTarget
lookupThAnnLookup (TH.AnnLookupName Name
th_nm) = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall name. name -> AnnTarget name
NamedTarget (Name -> TcM Name
lookupThName Name
th_nm)
lookupThAnnLookup (TH.AnnLookupModule (TH.Module PkgName
pn ModName
mn))
  = forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall name. GenModule Unit -> AnnTarget name
ModuleTarget forall a b. (a -> b) -> a -> b
$
    forall u. u -> ModuleName -> GenModule u
mkModule (String -> Unit
stringToUnit forall a b. (a -> b) -> a -> b
$ PkgName -> String
TH.pkgString PkgName
pn) (String -> ModuleName
mkModuleName forall a b. (a -> b) -> a -> b
$ ModName -> String
TH.modString ModName
mn)

reifyAnnotations :: Data a => TH.AnnLookup -> TcM [a]
reifyAnnotations :: forall a. Data a => AnnLookup -> TcM [a]
reifyAnnotations AnnLookup
th_name
  = do { CoreAnnTarget
name <- AnnLookup -> TcM CoreAnnTarget
lookupThAnnLookup AnnLookup
th_name
       ; HscEnv
topEnv <- forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
       ; AnnEnv
epsHptAnns <- forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ HscEnv -> Maybe ModGuts -> IO AnnEnv
prepareAnnotations HscEnv
topEnv forall a. Maybe a
Nothing
       ; TcGblEnv
tcg <- forall gbl lcl. TcRnIf gbl lcl gbl
getGblEnv
       ; let selectedEpsHptAnns :: [a]
selectedEpsHptAnns = forall a.
Typeable a =>
([Word8] -> a) -> AnnEnv -> CoreAnnTarget -> [a]
findAnns forall a. Data a => [Word8] -> a
deserializeWithData AnnEnv
epsHptAnns CoreAnnTarget
name
       ; let selectedTcgAnns :: [a]
selectedTcgAnns = forall a.
Typeable a =>
([Word8] -> a) -> AnnEnv -> CoreAnnTarget -> [a]
findAnns forall a. Data a => [Word8] -> a
deserializeWithData (TcGblEnv -> AnnEnv
tcg_ann_env TcGblEnv
tcg) CoreAnnTarget
name
       ; forall (m :: * -> *) a. Monad m => a -> m a
return ([a]
selectedEpsHptAnns forall a. [a] -> [a] -> [a]
++ [a]
selectedTcgAnns) }

------------------------------
modToTHMod :: Module -> TH.Module
modToTHMod :: GenModule Unit -> Module
modToTHMod GenModule Unit
m = PkgName -> ModName -> Module
TH.Module (String -> PkgName
TH.PkgName forall a b. (a -> b) -> a -> b
$ forall u. IsUnitId u => u -> String
unitString  forall a b. (a -> b) -> a -> b
$ forall unit. GenModule unit -> unit
moduleUnit GenModule Unit
m)
                         (String -> ModName
TH.ModName forall a b. (a -> b) -> a -> b
$ ModuleName -> String
moduleNameString forall a b. (a -> b) -> a -> b
$ forall unit. GenModule unit -> ModuleName
moduleName GenModule Unit
m)

reifyModule :: TH.Module -> TcM TH.ModuleInfo
reifyModule :: Module -> TcM ModuleInfo
reifyModule (TH.Module (TH.PkgName String
pkgString) (TH.ModName String
mString)) = do
  GenModule Unit
this_mod <- forall (m :: * -> *). HasModule m => m (GenModule Unit)
getModule
  let reifMod :: GenModule Unit
reifMod = forall u. u -> ModuleName -> GenModule u
mkModule (String -> Unit
stringToUnit String
pkgString) (String -> ModuleName
mkModuleName String
mString)
  if (GenModule Unit
reifMod forall a. Eq a => a -> a -> Bool
== GenModule Unit
this_mod) then TcM ModuleInfo
reifyThisModule else GenModule Unit -> TcM ModuleInfo
reifyFromIface GenModule Unit
reifMod
    where
      reifyThisModule :: TcM ModuleInfo
reifyThisModule = do
        [Module]
usages <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (forall a b. (a -> b) -> [a] -> [b]
map GenModule Unit -> Module
modToTHMod forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. ModuleEnv a -> [GenModule Unit]
moduleEnvKeys forall b c a. (b -> c) -> (a -> b) -> a -> c
. ImportAvails -> ImportedMods
imp_mods) TcRn ImportAvails
getImports
        forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ [Module] -> ModuleInfo
TH.ModuleInfo [Module]
usages

      reifyFromIface :: GenModule Unit -> TcM ModuleInfo
reifyFromIface GenModule Unit
reifMod = do
        ModIface
iface <- SDoc -> GenModule Unit -> IOEnv (Env TcGblEnv TcLclEnv) ModIface
loadInterfaceForModule (String -> SDoc
text String
"reifying module from TH for" SDoc -> SDoc -> SDoc
<+> forall a. Outputable a => a -> SDoc
ppr GenModule Unit
reifMod) GenModule Unit
reifMod
        let usages :: [Module]
usages = [GenModule Unit -> Module
modToTHMod GenModule Unit
m | Usage
usage <- forall (phase :: ModIfacePhase). ModIface_ phase -> [Usage]
mi_usages ModIface
iface,
                                     Just GenModule Unit
m <- [Unit -> Usage -> Maybe (GenModule Unit)
usageToModule (forall unit. GenModule unit -> unit
moduleUnit GenModule Unit
reifMod) Usage
usage] ]
        forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ [Module] -> ModuleInfo
TH.ModuleInfo [Module]
usages

      usageToModule :: Unit -> Usage -> Maybe Module
      usageToModule :: Unit -> Usage -> Maybe (GenModule Unit)
usageToModule Unit
_ (UsageFile {}) = forall a. Maybe a
Nothing
      usageToModule Unit
this_pkg (UsageHomeModule { usg_mod_name :: Usage -> ModuleName
usg_mod_name = ModuleName
mn }) = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ forall u. u -> ModuleName -> GenModule u
mkModule Unit
this_pkg ModuleName
mn
      usageToModule Unit
_ (UsagePackageModule { usg_mod :: Usage -> GenModule Unit
usg_mod = GenModule Unit
m }) = forall a. a -> Maybe a
Just GenModule Unit
m
      usageToModule Unit
_ (UsageMergedRequirement { usg_mod :: Usage -> GenModule Unit
usg_mod = GenModule Unit
m }) = forall a. a -> Maybe a
Just GenModule Unit
m

------------------------------
mkThAppTs :: TH.Type -> [TH.Type] -> TH.Type
mkThAppTs :: Type -> [Type] -> Type
mkThAppTs Type
fun_ty [Type]
arg_tys = forall (t :: * -> *) b a.
Foldable t =>
(b -> a -> b) -> b -> t a -> b
foldl' Type -> Type -> Type
TH.AppT Type
fun_ty [Type]
arg_tys

noTH :: PtrString -> SDoc -> TcM a
noTH :: forall a. PtrString -> SDoc -> TcM a
noTH PtrString
s SDoc
d = forall a. SDoc -> TcM a
failWithTc ([SDoc] -> SDoc
hsep [String -> SDoc
text String
"Can't represent" SDoc -> SDoc -> SDoc
<+> PtrString -> SDoc
ptext PtrString
s SDoc -> SDoc -> SDoc
<+>
                                String -> SDoc
text String
"in Template Haskell:",
                             SumArity -> SDoc -> SDoc
nest SumArity
2 SDoc
d])

ppr_th :: TH.Ppr a => a -> SDoc
ppr_th :: forall a. Ppr a => a -> SDoc
ppr_th a
x = String -> SDoc
text (forall a. Ppr a => a -> String
TH.pprint a
x)

{-
Note [Reifying field labels]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When reifying a datatype declared with DuplicateRecordFields enabled, we want
the reified names of the fields to be labels rather than selector functions.
That is, we want (reify ''T) and (reify 'foo) to produce

    data T = MkT { foo :: Int }
    foo :: T -> Int

rather than

    data T = MkT { $sel:foo:MkT :: Int }
    $sel:foo:MkT :: T -> Int

because otherwise TH code that uses the field names as strings will silently do
the wrong thing.  Thus we use the field label (e.g. foo) as the OccName, rather
than the selector (e.g. $sel:foo:MkT).  Since the Orig name M.foo isn't in the
environment, NameG can't be used to represent such fields.  Instead,
reifyFieldLabel uses NameQ.

However, this means that extracting the field name from the output of reify, and
trying to reify it again, may fail with an ambiguity error if there are multiple
such fields defined in the module (see the test case
overloadedrecflds/should_fail/T11103.hs).  The "proper" fix requires changes to
the TH AST to make it able to represent duplicate record fields.
-}

tcGetInterp :: TcM Interp
tcGetInterp :: TcM Interp
tcGetInterp = do
   HscEnv
hsc_env <- forall gbl lcl. TcRnIf gbl lcl HscEnv
getTopEnv
   case HscEnv -> Maybe Interp
hsc_interp HscEnv
hsc_env of
      Maybe Interp
Nothing -> forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ forall e a. Exception e => e -> IO a
throwIO (String -> GhcException
InstallationError String
"Template haskell requires a target code interpreter")
      Just Interp
i  -> forall (f :: * -> *) a. Applicative f => a -> f a
pure Interp
i